Struct Stream 

pub struct Stream<P> { /* private fields */ }

Handle to one permanent Stream path.

Implementations

impl<P: StreamProvider> Stream<P>

pub const fn path(&self) -> &StreamPath

Permanent path.

pub async fn tail(&self) -> Result<u64, StreamError>

Current tail.

pub async fn append( &self, value: impl Into<Bytes>, ) -> Result<AppendOutcome, StreamError>

Unconditionally appends one record.

pub async fn append_at( &self, value: impl Into<Bytes>, if_tail: u64, ) -> Result<AppendOutcome, StreamError>

Appends one record only at the exact tail.

pub async fn append_batch( &self, records: Vec<Bytes>, if_tail: Option<u64>, idempotency_key: Option<IdempotencyKey>, ) -> Result<AppendOutcome, StreamError>

Atomically appends a contiguous batch.

pub async fn fork( &self, destination: impl AsRef<str>, at_tail: Option<u64>, idempotency_key: Option<IdempotencyKey>, ) -> Result<ForkReceipt, StreamError>

Forks the current or selected retained prefix.

pub async fn trim( &self, before: u64, idempotency_key: Option<IdempotencyKey>, ) -> Result<TrimReceipt, StreamError>

Monotonically advances the earliest readable sequence.

pub async fn delete( &self, idempotency_key: Option<IdempotencyKey>, ) -> Result<DeleteReceipt, StreamError>

Permanently retires this path.

pub async fn read( &self, from: u64, limit: u32, ) -> Result<RecordStream, StreamError>

Reads at most limit records from from.

pub async fn follow(&self, from: u64) -> Result<RecordStream, StreamError>

Replays from from, then remains live.

Trait Implementations

impl<P> Clone for Stream<P>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.