Struct timely::dataflow::operators::generic::OutputWrapper

pub struct OutputWrapper<T: Timestamp, CB: ContainerBuilder, P: Push<Message<T, CB::Container>>> { /* private fields */ }

An owned instance of an output buffer which ensures certain API use.

An OutputWrapper exists to prevent anyone from using the wrapped buffer in any way other than with an OutputHandle, whose methods ensure that capabilities are used and that the pusher is flushed (via the cease method) once it is no longer used.

Implementations

impl<T: Timestamp, CB: ContainerBuilder, P: Push<Message<T, CB::Container>>> OutputWrapper<T, CB, P>

pub fn new( push_buffer: Buffer<T, CB, PushCounter<T, CB::Container, P>>, internal_buffer: Rc<RefCell<ChangeBatch<T>>>, ) -> Self

Creates a new output wrapper from a push buffer.

pub fn activate(&mut self) -> OutputHandleCore<'_, T, CB, P>

Borrows the push buffer into a handle, which can be used to send records.

This method ensures that the only access to the push buffer is through the OutputHandle type which ensures the use of capabilities, and which calls cease when it is dropped.

Trait Implementations

impl<T: Debug + Timestamp, CB: Debug + ContainerBuilder, P: Debug + Push<Message<T, CB::Container>>> Debug for OutputWrapper<T, CB, P>

where CB::Container: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.