Skip to main content

OperatorWriteOutput

Struct OperatorWriteOutput 

Source
pub struct OperatorWriteOutput {
    pub write_prologue: TokenStream,
    pub write_prologue_after: TokenStream,
    pub write_iterator: TokenStream,
    pub write_iterator_after: TokenStream,
    pub write_tick_end: TokenStream,
}
Expand description

The code generated and returned by a OperatorConstraints::write_fn. Important: When destructuring this struct in delegating operators, list all fields explicitly rather than using .. to ensure new fields are not silently dropped.

Fields§

§write_prologue: TokenStream

Code which runs once outside any subgraphs, BEFORE subgraphs are initialized, to set up any external state (state API, chanels, network connections, etc.) to be used by the subgraph.

§write_prologue_after: TokenStream

Code which runs once outside the subgraph, AFTER subgraphs are initialized, to set up state hooks which may need the subgraph ID.

§write_iterator: TokenStream

Iterator (or pusherator) code inside the subgraphs. The code for each operator is emitted in order.

Emitted code should assign to WriteContextArgs::ident and use WriteContextArgs::inputs (pull Streams) or WriteContextArgs::outputs (push Sinks).

§write_iterator_after: TokenStream

Code which runs after Streams/Sinks have been run. Mainly for flushing IO.

§write_tick_end: TokenStream

Code which runs at the end of each tick, after all subgraphs have run. Used for resetting state with 'tick persistence.

Trait Implementations§

Source§

impl Default for OperatorWriteOutput

Source§

fn default() -> OperatorWriteOutput

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.