Struct timely::dataflow::operators::CapabilityRef

pub struct CapabilityRef<'cap, T: Timestamp + 'cap> { /* private fields */ }

An unowned capability, which can be used but not retained.

The capability reference supplies a retain(self) method which consumes the reference and turns it into an owned capability

Implementations

impl<'cap, T: Timestamp + 'cap> CapabilityRef<'cap, T>

pub fn time(&self) -> &T

The timestamp associated with this capability.

pub fn delayed(&self, new_time: &T) -> Capability<T>

Makes a new capability for a timestamp new_time greater or equal to the timestamp of the source capability (self).

This method panics if self.time is not less or equal to new_time.

pub fn delayed_for_output(
    &self,
    new_time: &T,
    output_port: usize
) -> Capability<T>

Delays capability for a specific output port.

pub fn retain(self) -> Capability<T>

Transform to an owned capability.

This method produces an owned capability which must be dropped to release the capability. Users should take care that these capabilities are only stored for as long as they are required, as failing to drop them may result in livelock.

pub fn retain_for_output(self, output_port: usize) -> Capability<T>

Transforms to an owned capability for a specific output port.

Trait Implementations

impl<'cap, T: Timestamp> Debug for CapabilityRef<'cap, T>

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

Formats the value using the given formatter.

impl<'cap, T: Timestamp> Deref for CapabilityRef<'cap, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.