Struct persist::client::MultiWriteHandle

pub struct MultiWriteHandle {
    stream_ids: HashSet<Id>,
    client: Result<RuntimeClient, Error>,
}

A handle for writing to multiple streams.

Fields

stream_ids: HashSet<Id>

client: Result<RuntimeClient, Error>

Implementations

impl MultiWriteHandle

pub fn err(&self) -> Option<Error>

Returns Some(Error) in case any initialization operation on this MultiWriteHandle resulted in an Error.

pub fn new<K: Codec, V: Codec>(handle: &StreamWriteHandle<K, V>) -> Self

Returns a new MultiWriteHandle for the given stream.

pub fn new_from_streams<K, V, H, I>(handles: I) -> Result<Self, Error> where
    K: Codec,
    V: Codec,
    H: Borrow<StreamWriteHandle<K, V>>,
    I: Iterator<Item = H>, 

Returns a new MultiWriteHandle for the given streams.

Convenience function for when all the streams have matching K and V.

NOTE: This only returns an Error in case the passed iterator contains no handles or when passing in handles from different persist runtimes. All other errors are handled internally.

pub fn add_stream<K: Codec, V: Codec>(
    &mut self,
    handle: &StreamWriteHandle<K, V>
) -> Result<(), Error>

Adds the given stream to the set

NOTE: This only returns an Error when passing in handles from different persist runtimes. All other errors are handled internally.

pub fn write_atomic<F: FnOnce(&mut AtomicWriteBuilder<'_>) -> Result<(), Error>>(
    &self,
    f: F
) -> PFuture<SeqNo>

Atomically writes the given updates to the paired streams.

Either all of the writes will be made durable for replay or none of them will.

pub fn seal(&self, ids: &[Id], upper: u64) -> PFuture<SeqNo>

Closes the streams at the given timestamp, migrating data strictly less than it into the trace.

Ids may not be duplicated (this is equivalent to sealing the stream twice at the same timestamp, which we currently disallow).

pub fn seal_all(&self, upper: u64) -> PFuture<SeqNo>

Closes all contained streams at the given timestamp, migrating data strictly less than it into the trace.

pub fn allow_compaction(
    &self,
    id_sinces: &[(Id, Antichain<u64>)]
) -> PFuture<SeqNo>

Unblocks compaction for updates for the given streams at the paired since timestamp.

Ids may not be duplicated (this is equivalent to allowing compaction on the stream twice at the same timestamp, which we currently disallow).

pub fn allow_compaction_all(&self, since: Antichain<u64>) -> PFuture<SeqNo>

Atomically unblocks compaction for all contained streams up to the given since frontier.

Trait Implementations

impl Clone for MultiWriteHandle

fn clone(&self) -> MultiWriteHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MultiWriteHandle

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

Formats the value using the given formatter.

impl PartialEq<MultiWriteHandle> for MultiWriteHandle

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.