Struct GuardedStreamReader

pub struct GuardedStreamReader<T, A>
where
    A: AsAccessor,
{ /* private fields */ }

A StreamReader paired with an [Accessor].

This is an RAII wrapper around StreamReader that ensures it is closed when dropped. This can be created through GuardedStreamReader::new or StreamReader::guard.

Implementations

impl<T, A> GuardedStreamReader<T, A>

where A: AsAccessor,

pub fn new(accessor: A, reader: StreamReader<T>) -> GuardedStreamReader<T, A>

Create a new GuardedStreamReader with the specified accessor and reader.

pub fn is_closed(&self) -> bool

Wrapper for StreamReader::is_closed

pub async fn read<B>(&mut self, buffer: B) -> B

where T: Lift + 'static, B: ReadBuffer<T> + Send + 'static,

Wrapper for StreamReader::read.

pub async fn watch_writer(&mut self)

Wrapper for StreamReader::watch_writer.

pub fn into_stream(self) -> StreamReader<T>

Extracts the underlying StreamReader from this guard, returning it back.

Trait Implementations

impl<T, A> Drop for GuardedStreamReader<T, A>

where A: AsAccessor,

fn drop(&mut self)

Executes the destructor for this type.

impl<T, A> From<GuardedStreamReader<T, A>> for StreamReader<T>

where A: AsAccessor,

fn from(guard: GuardedStreamReader<T, A>) -> StreamReader<T>

Converts to this type from the input type.