Struct timely::dataflow::channels::pushers::buffer::Buffer

pub struct Buffer<T, CB, P> { /* private fields */ }

Buffers data sent at the same time, for efficient communication.

The Buffer type should be used by calling session with a time, which checks whether data must be flushed and creates a Session object which allows sending at the given time.

Implementations

impl<T, CB: Default, P> Buffer<T, CB, P>

pub fn new(pusher: P) -> Self

Creates a new Buffer.

pub fn inner(&mut self) -> &mut P

Returns a reference to the inner P: Push type.

This is currently used internally, and should not be used without some care.

pub fn builder(&self) -> &CB

Access the builder. Immutable access to prevent races with flushing the underlying buffer.

impl<T, C: Container + Data, P: Push<Message<T, C>>> Buffer<T, CapacityContainerBuilder<C>, P>

where T: Eq + Clone,

pub fn session( &mut self, time: &T, ) -> Session<'_, T, CapacityContainerBuilder<C>, P>

Returns a Session, which accepts data to send at the associated time

pub fn autoflush_session( &mut self, cap: Capability<T>, ) -> AutoflushSession<'_, T, CapacityContainerBuilder<C>, P>

where T: Timestamp,

Allocates a new AutoflushSession which flushes itself on drop.

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

where T: Eq + Clone,

pub fn session_with_builder(&mut self, time: &T) -> Session<'_, T, CB, P>

Returns a Session, which accepts data to send at the associated time

pub fn autoflush_session_with_builder( &mut self, cap: Capability<T>, ) -> AutoflushSession<'_, T, CB, P>

where T: Timestamp,

Allocates a new AutoflushSession which flushes itself on drop.

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

where T: Eq + Clone,

pub fn cease(&mut self)

Flushes all data and pushes a None to self.pusher, indicating a flush.

Trait Implementations

impl<T: Debug, CB: Debug, P: Debug> Debug for Buffer<T, CB, P>

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

Formats the value using the given formatter.

impl<T, CB, P, D> PushInto<D> for Buffer<T, CB, P>

where T: Eq + Clone, CB: ContainerBuilder + PushInto<D>, P: Push<Message<T, CB::Container>>,

fn push_into(&mut self, item: D)

Push item into self.