Struct differential_dataflow::trace::wrappers::rc::TraceRc

pub struct TraceRc<Tr: TraceReader> {
    pub wrapper: Rc<RefCell<TraceBox<Tr>>>,
    /* private fields */
}

A handle to a shared trace.

As long as the handle exists, the wrapped trace should continue to exist and will not advance its timestamps past the frontier maintained by the handle. The intent is that such a handle appears as if it is a privately maintained trace, despite being backed by shared resources.

Fields

wrapper: Rc<RefCell<TraceBox<Tr>>>

Wrapped trace. Please be gentle when using.

Implementations

impl<Tr: TraceReader> TraceRc<Tr>

pub fn make_from(trace: Tr) -> (Self, Rc<RefCell<TraceBox<Tr>>>)

Allocates a new handle from an existing wrapped wrapper.

Trait Implementations

impl<Tr: TraceReader> Clone for TraceRc<Tr>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Tr: TraceReader> Drop for TraceRc<Tr>

fn drop(&mut self)

Executes the destructor for this type.

impl<Tr: TraceReader> TraceReader for TraceRc<Tr>

fn set_logical_compaction(&mut self, frontier: AntichainRef<'_, Tr::Time>)

Sets frontier to now be elements in frontier.

This change may not have immediately observable effects. It informs the shared trace that this handle no longer requires access to times other than those in the future of frontier, but if there are other handles to the same trace, it may not yet be able to compact.

fn set_physical_compaction(&mut self, frontier: AntichainRef<'_, Tr::Time>)

Allows the trace to compact batches of times before frontier.

fn cursor_through( &mut self, frontier: AntichainRef<'_, Tr::Time>, ) -> Option<(Tr::Cursor, Tr::Storage)>

Creates a new cursor over the wrapped trace.

type Key<'a> = <Tr as TraceReader>::Key<'a>

Key by which updates are indexed.

type Val<'a> = <Tr as TraceReader>::Val<'a>

Values associated with keys.

type Time = <Tr as TraceReader>::Time

Timestamps associated with updates

type TimeGat<'a> = <Tr as TraceReader>::TimeGat<'a>

Borrowed form of timestamp.

type Diff = <Tr as TraceReader>::Diff

Owned form of update difference.

type DiffGat<'a> = <Tr as TraceReader>::DiffGat<'a>

Borrowed form of update difference.

type Batch = <Tr as TraceReader>::Batch

The type of an immutable collection of updates.

type Storage = <Tr as TraceReader>::Storage

Storage type for Self::Cursor. Likely related to Self::Batch.

type Cursor = <Tr as TraceReader>::Cursor

The type used to enumerate the collections contents.

fn get_logical_compaction(&mut self) -> AntichainRef<'_, Tr::Time>

Reports the logical compaction frontier.

fn get_physical_compaction(&mut self) -> AntichainRef<'_, Tr::Time>

Reports the physical compaction frontier.

fn map_batches<F: FnMut(&Self::Batch)>(&self, f: F)

Maps logic across the non-empty sequence of batches in the trace.

fn cursor(&mut self) -> (Self::Cursor, Self::Storage)

Provides a cursor over updates contained in the trace.

fn advance_by(&mut self, frontier: AntichainRef<'_, Self::Time>)

👎Deprecated since 0.11: please use set_logical_compaction

Deprecated form of set_logical_compaction.

fn advance_frontier(&mut self) -> AntichainRef<'_, Self::Time>

👎Deprecated since 0.11: please use get_logical_compaction

Deprecated form of get_logical_compaction.

fn distinguish_since(&mut self, frontier: AntichainRef<'_, Self::Time>)

👎Deprecated since 0.11: please use set_physical_compaction

Deprecated form of set_physical_compaction.

fn distinguish_frontier(&mut self) -> AntichainRef<'_, Self::Time>

👎Deprecated since 0.11: please use get_physical_compaction

Deprecated form of get_physical_compaction.

fn read_upper(&mut self, target: &mut Antichain<Self::Time>)

Reads the upper frontier of committed times.

fn advance_upper(&mut self, upper: &mut Antichain<Self::Time>)

Advances upper by any empty batches.