Struct ByteStream 

pub struct ByteStream { /* private fields */ }

An append-only byte buffer with terminal state and parked ranged reads.

Implementations

impl ByteStream

pub fn new() -> Self

Create an empty, open stream.

pub fn push(&self, bytes: &[u8]) -> bool

Append bytes and wake parked readers.

Returns false (dropping the bytes) if the stream is closed.

pub fn close(&self)

Close the stream and wake parked readers. Idempotent.

pub fn is_closed(&self) -> bool

Whether the stream is closed.

pub fn len(&self) -> u64

Total bytes appended so far.

pub fn is_empty(&self) -> bool

Whether no bytes have been appended.

pub fn snapshot_at(&self, offset: u64, max: usize) -> ByteChunk

Non-blocking ranged read: whatever is available right now.

pub async fn read_at(&self, offset: u64, max: usize) -> ByteChunk

read(2): park until at least one byte past offset exists or the stream is closed. Returns an empty chunk exactly at end-of-stream.

pub async fn read_at_cancellable( &self, offset: u64, max: usize, token: &CancelToken, ) -> Result<ByteChunk, Cancelled>

ByteStream::read_at, cancellable.

Trait Implementations

impl Default for ByteStream

fn default() -> Self

Returns the “default value” for a type.