Struct ogg::reading::async_api::PacketReader

pub struct PacketReader<T>
where
    T: TokioAsyncRead,
{ /* private fields */ }

Available on crate feature async only.

Async packet reading functionality.

Implementations

impl<T: TokioAsyncRead> PacketReader<T>

pub fn new(inner: T) -> Self

Wraps the specified Tokio runtime AsyncRead into an Ogg packet reader.

This is the recommended constructor when using the Tokio runtime types.

impl<T: FuturesAsyncRead> PacketReader<Compat<T>>

pub fn new_compat(inner: T) -> Self

Wraps the specified futures_io AsyncRead into an Ogg packet reader.

This crate uses Tokio internally, so a wrapper that may have some performance cost will be used. Therefore, this constructor is to be used only when dealing with AsyncRead implementations from other runtimes, and implementing a Tokio AsyncRead compatibility layer oneself is not desired.

Trait Implementations

impl<T: TokioAsyncRead> Stream for PacketReader<T>

type Item = Result<Packet, OggReadError>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'pin, T> Unpin for PacketReader<T>

where T: TokioAsyncRead, __PacketReader<'pin, T>: Unpin,