Struct Capability

pub struct Capability<T: Timestamp> { /* private fields */ }

The capability to send data with a certain timestamp on a dataflow edge.

Capabilities are used by timely dataflow’s progress tracking machinery to restrict and track when user code retains the ability to send messages on dataflow edges. All capabilities are constructed by the system, and should eventually be dropped by the user. Failure to drop a capability (for whatever reason) will cause timely dataflow’s progress tracking to stall.

Implementations

impl<T: Timestamp> Capability<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 try_delayed(&self, new_time: &T) -> Option<Capability<T>>

Attempts to make a new capability for a timestamp new_time that is greater or equal to the timestamp of the source capability (self).

Returns None self.time is not less or equal to new_time.

pub fn downgrade(&mut self, new_time: &T)

Downgrades the capability to one corresponding to new_time.

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

pub fn try_downgrade(&mut self, new_time: &T) -> Result<(), DowngradeError>

Attempts to downgrade the capability to one corresponding to new_time.

Returns a DowngradeError if self.time is not less or equal to new_time.

Trait Implementations

impl<T: Timestamp> Clone for Capability<T>

fn clone(&self) -> Capability<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Timestamp> Debug for Capability<T>

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

Formats the value using the given formatter.

impl<T: Timestamp> Deref for Capability<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: Timestamp> Drop for Capability<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Timestamp> Hash for Capability<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Timestamp> PartialEq for Capability<T>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Timestamp> PartialOrder for Capability<T>

fn less_equal(&self, other: &Self) -> bool

Returns true iff one element is less than or equal to the other.

fn less_than(&self, other: &Rhs) -> bool

Returns true iff one element is strictly less than the other.

impl<T: Timestamp> Eq for Capability<T>