Struct mz_timely_util::probe::Handle

pub struct Handle<T: Timestamp> {
    frontier: Rc<RefCell<MutableAntichain<T>>>,
    handle_frontier: Antichain<T>,
    notify: Rc<Notify>,
}

Fields

frontier: Rc<RefCell<MutableAntichain<T>>>

The overall shared frontier managed by all the handles

handle_frontier: Antichain<T>

The private frontier containing the changes produced by this handle only

notify: Rc<Notify>

Implementations

impl<T: Timestamp> Handle<T>

pub async fn progressed(&self)

Wait for the frontier monitored by this probe to progress

pub fn less_than(&self, time: &T) -> bool

Returns true iff the frontier is strictly less than time.

pub fn less_equal(&self, time: &T) -> bool

Returns true iff the frontier is less than or equal to time.

pub fn done(&self) -> bool

Returns true iff the frontier is empty.

pub fn with_frontier<R, F: FnMut(AntichainRef<'_, T>) -> R>( &self, function: F, ) -> R

Invokes a method on the frontier, returning its result.

This method allows inspection of the frontier, which cannot be returned by reference as it is on the other side of a RefCell.

Examples

use mz_timely_util::probe::Handle;

let handle = Handle::<usize>::default();
let frontier = handle.with_frontier(|frontier| frontier.to_vec());

fn update_frontier(&mut self, new_frontier: &[T])

Trait Implementations

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Timestamp> Debug for Handle<T>

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

Formats the value using the given formatter.

impl<T: Timestamp> Default for Handle<T>

fn default() -> Self

Returns the “default value” for a type.

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

fn drop(&mut self)

Executes the destructor for this type.