Struct timely::dataflow::operators::Capability [−][src]
pub struct Capability<T: Timestamp> { /* fields omitted */ }
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.
Methods
impl<T: Timestamp> Capability<T>
[src]
impl<T: Timestamp> Capability<T>
ⓘImportant traits for &'a mut Rpub fn time(&self) -> &T
[src]
pub fn time(&self) -> &T
The timestamp associated with this capability.
pub fn delayed(&self, new_time: &T) -> Capability<T>
[src]
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 downgrade(&mut self, new_time: &T)
[src]
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
.
Trait Implementations
impl<T: Timestamp> Drop for Capability<T>
[src]
impl<T: Timestamp> Drop for Capability<T>
impl<T: Timestamp> Clone for Capability<T>
[src]
impl<T: Timestamp> Clone for Capability<T>
fn clone(&self) -> Capability<T>
[src]
fn clone(&self) -> Capability<T>
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl<T: Timestamp> Deref for Capability<T>
[src]
impl<T: Timestamp> Deref for Capability<T>
type Target = T
The resulting type after dereferencing.
ⓘImportant traits for &'a mut Rfn deref(&self) -> &T
[src]
fn deref(&self) -> &T
Dereferences the value.
impl<T: Timestamp> Debug for Capability<T>
[src]
impl<T: Timestamp> Debug for Capability<T>
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl<T: Timestamp> PartialEq for Capability<T>
[src]
impl<T: Timestamp> PartialEq for Capability<T>
fn eq(&self, other: &Self) -> bool
[src]
fn eq(&self, other: &Self) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<T: Timestamp> Eq for Capability<T>
[src]
impl<T: Timestamp> Eq for Capability<T>
impl<T: Timestamp> PartialOrder for Capability<T>
[src]
impl<T: Timestamp> PartialOrder for Capability<T>
fn less_equal(&self, other: &Self) -> bool
[src]
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: &Self) -> bool
[src]
fn less_than(&self, other: &Self) -> bool
Returns true iff one element is strictly less than the other.
impl<T: Timestamp> Hash for Capability<T>
[src]
impl<T: Timestamp> Hash for Capability<T>
Auto Trait Implementations
impl<T> !Send for Capability<T>
impl<T> !Send for Capability<T>
impl<T> !Sync for Capability<T>
impl<T> !Sync for Capability<T>