Struct grpcio::MessageReader

pub struct MessageReader { /* fields omitted */ }

MessageReader is a zero-copy reader for the message payload.

To achieve zero-copy, use the BufRead API fill_buf and consume to operate the reader.

Methods

impl MessageReader

pub fn pending_bytes_count(&self) -> usize

Get the available bytes count of the reader.

Trait Implementations

impl Drop for MessageReader

fn drop(&mut self)

Executes the destructor for this type.

impl Sync for MessageReader

impl Send for MessageReader

impl Read for MessageReader

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>

Read all bytes until EOF in this source, placing them into buf.

default fn read_vectored(
    &mut self,
    bufs: &mut [IoVecMut]
) -> Result<usize, Error>

🔬 This is a nightly-only experimental API. (iovec)

Like read, except that it reads into a slice of buffers.

unsafe default fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

default fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

default fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

default fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

default fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

default fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

default fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.

impl BufRead for MessageReader

fn fill_buf(&mut self) -> Result<&[u8]>

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

fn consume(&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 read.

default fn read_until(
    &mut self,
    byte: u8,
    buf: &mut Vec<u8>
) -> Result<usize, Error>

Read all bytes into buf until the delimiter byte or EOF is reached.

default fn read_line(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until a newline (the 0xA byte) is reached, and append them to the provided buffer.

default fn split(self, byte: u8) -> Split<Self>

Returns an iterator over the contents of this reader split on the byte byte.

default fn lines(self) -> Lines<Self>

Returns an iterator over the lines of this reader.

impl Buf for MessageReader

fn remaining(&self) -> usize

Returns the number of bytes between the current position and the end of the buffer.

fn bytes(&self) -> &[u8]

Returns a slice starting at the current position and of length between 0 and Buf::remaining(). Note that this can return shorter slice (this allows non-continuous internal representation).

fn advance(&mut self, cnt: usize)

Advance the internal cursor of the Buf

default fn bytes_vec(&'a self, dst: &mut [&'a IoVec]) -> usize

Fills dst with potentially multiple slices starting at self's current position.

default fn has_remaining(&self) -> bool

Returns true if there are any more bytes to consume

default fn copy_to_slice(&mut self, dst: &mut [u8])

Copies bytes from self into dst.

default fn get_u8(&mut self) -> u8

Gets an unsigned 8 bit integer from self.

default fn get_i8(&mut self) -> i8

Gets a signed 8 bit integer from self.

default fn get_u16_be(&mut self) -> u16

Gets an unsigned 16 bit integer from self in big-endian byte order.

default fn get_u16_le(&mut self) -> u16

Gets an unsigned 16 bit integer from self in little-endian byte order.

default fn get_i16_be(&mut self) -> i16

Gets a signed 16 bit integer from self in big-endian byte order.

default fn get_i16_le(&mut self) -> i16

Gets a signed 16 bit integer from self in little-endian byte order.

default fn get_u32_be(&mut self) -> u32

Gets an unsigned 32 bit integer from self in the big-endian byte order.

default fn get_u32_le(&mut self) -> u32

Gets an unsigned 32 bit integer from self in the little-endian byte order.

default fn get_i32_be(&mut self) -> i32

Gets a signed 32 bit integer from self in big-endian byte order.

default fn get_i32_le(&mut self) -> i32

Gets a signed 32 bit integer from self in little-endian byte order.

default fn get_u64_be(&mut self) -> u64

Gets an unsigned 64 bit integer from self in big-endian byte order.

default fn get_u64_le(&mut self) -> u64

Gets an unsigned 64 bit integer from self in little-endian byte order.

default fn get_i64_be(&mut self) -> i64

Gets a signed 64 bit integer from self in big-endian byte order.

default fn get_i64_le(&mut self) -> i64

Gets a signed 64 bit integer from self in little-endian byte order.

default fn get_uint_be(&mut self, nbytes: usize) -> u64

Gets an unsigned n-byte integer from self in big-endian byte order.

default fn get_uint_le(&mut self, nbytes: usize) -> u64

Gets an unsigned n-byte integer from self in little-endian byte order.

default fn get_int_be(&mut self, nbytes: usize) -> i64

Gets a signed n-byte integer from self in big-endian byte order.

default fn get_int_le(&mut self, nbytes: usize) -> i64

Gets a signed n-byte integer from self in little-endian byte order.

default fn get_f32_be(&mut self) -> f32

Gets an IEEE754 single-precision (4 bytes) floating point number from self in big-endian byte order.

default fn get_f32_le(&mut self) -> f32

Gets an IEEE754 single-precision (4 bytes) floating point number from self in little-endian byte order.

default fn get_f64_be(&mut self) -> f64

Gets an IEEE754 double-precision (8 bytes) floating point number from self in big-endian byte order.

default fn get_f64_le(&mut self) -> f64

Gets an IEEE754 double-precision (8 bytes) floating point number from self in little-endian byte order.

default fn collect<B>(self) -> B where
    B: FromBuf, 

Transforms a Buf into a concrete buffer.

default fn take(self, limit: usize) -> Take<Self>

Creates an adaptor which will read at most limit bytes from self.

default fn chain<U>(self, next: U) -> Chain<Self, <U as IntoBuf>::Buf> where
    U: IntoBuf, 

Creates an adaptor which will chain this buffer with another.

default fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Buf.

default fn reader(self) -> Reader<Self>

Creates an adaptor which implements the Read trait for self.

default fn iter(self) -> Iter<Self>

Returns an iterator over the bytes contained by the buffer.