Skip to main content

KernelContract

Struct KernelContract 

Source
pub struct KernelContract<'a> { /* private fields */ }
Expand description

The port-contract declaration handed to Kernel::get_contract — a safe wrapper around the internal Contract, valid only for the duration of that call.

Type ids live in crate::packet::type_id (I64 / F64 / BUFFER / …); 0 means “any type”. Invalid indexes, invalid type ids, duplicate/empty side-packet names, and panics make graph construction fail instead of being ignored.

Implementations§

Source§

impl KernelContract<'_>

Source

pub fn num_inputs(&self) -> usize

Source

pub fn num_outputs(&self) -> usize

Source

pub fn input_type(&mut self, i: usize, type_id: u64)

Declare the payload type of input port i (0 = any; use crate::packet::type_id::I64 and friends for the built-in types).

Source

pub fn output_type(&mut self, i: usize, type_id: u64)

Declare the payload type of output port i. See input_type.

Source

pub fn input_any(&mut self, i: usize)

Accept any payload type on input port i (the default).

Source

pub fn output_any(&mut self, i: usize)

Produce any payload type on output port i (the default).

Source

pub fn require_side_packet(&mut self, name: &str)

Declare a required side packet; if the host forgets to inject it, graph init fails.

Auto Trait Implementations§

§

impl<'a> !UnwindSafe for KernelContract<'a>

§

impl<'a> Freeze for KernelContract<'a>

§

impl<'a> RefUnwindSafe for KernelContract<'a>

§

impl<'a> Send for KernelContract<'a>

§

impl<'a> Sync for KernelContract<'a>

§

impl<'a> Unpin for KernelContract<'a>

§

impl<'a> UnsafeUnpin for KernelContract<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.