Struct nix_compat::wire::BytesReader

pub struct BytesReader<R, T: Tag = Pad> {
    state: State<R, T>,
}

Reads a “bytes wire packet” from the underlying reader. The format is the same as in crate::wire::bytes::read_bytes, however this structure provides a AsyncRead interface, allowing to not having to pass around the entire payload in memory.

It is constructed by reading a size with BytesReader::new, and yields payload data until the end of the packet is reached.

It will not return the final bytes before all padding has been successfully consumed as well, but the full length of the reader must be consumed.

If the data is not read all the way to the end, or an error is encountered, the underlying reader is no longer usable and might return garbage.

Fields

state: State<R, T>

Implementations

impl<R> BytesReader<R>

where R: AsyncRead + Unpin,

pub async fn new<S: RangeBounds<u64>>( reader: R, allowed_size: S ) -> Result<Self>

Constructs a new BytesReader, using the underlying passed reader.

impl<R, T: Tag> BytesReader<R, T>

where R: AsyncRead + Unpin,

pub(crate) async fn new_internal<S: RangeBounds<u64>>( reader: R, allowed_size: S ) -> Result<Self>

Constructs a new BytesReader, using the underlying passed reader.

pub fn is_empty(&self) -> bool

Returns whether there is any remaining data to be read.

pub fn len(&self) -> u64

Remaining data length, ie not including data already read.

If the size has not been read yet, this is None.

Trait Implementations

impl<R: AsyncBufRead + Unpin, T: Tag> AsyncBufRead for BytesReader<R, T>

fn poll_fill_buf( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<&[u8]>>

Attempts to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut Self>, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to poll_read.

impl<R: AsyncRead + Unpin, T: Tag> AsyncRead for BytesReader<R, T>

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_> ) -> Poll<Result<()>>

Attempts to read from the AsyncRead into buf.

impl<R: Debug, T: Debug + Tag> Debug for BytesReader<R, T>

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

Formats the value using the given formatter.