Struct ProgressSession

pub struct ProgressSession<'a, T: Timestamp, C, P: Push<Message<T, C>>> { /* private fields */ }

A session that provides access to a Progress but will flush when dropped.

The type of the container C must be known, as long as the flushing action requires a specific Push implementation.

Methods from Deref<Target = Progress<T, P>>

pub fn give<C: Container, CT: CapabilityTrait<T>>( &mut self, capability: &CT, container: &mut C, )

where P: Push<Message<T, C>>,

Ships a container using a provided capability.

On return, the container may hold undefined contents and should be cleared before it is reused.

pub fn activate<'a, C>(&'a mut self) -> ProgressSession<'a, T, C, P>

where P: Push<Message<T, C>>,

Activates a Progress into a ProgressSession which will flush when dropped.

pub fn valid<CT: CapabilityTrait<T>>(&self, capability: &CT) -> bool

Determines if the capability is valid for this output.

Trait Implementations

impl<'a, T: Timestamp, C, P: Push<Message<T, C>>> Deref for ProgressSession<'a, T, C, P>

type Target = Progress<T, P>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, T: Timestamp, C, P: Push<Message<T, C>>> DerefMut for ProgressSession<'a, T, C, P>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, T: Timestamp, C, P: Push<Message<T, C>>> Drop for ProgressSession<'a, T, C, P>

fn drop(&mut self)

Executes the destructor for this type.