Struct bytes::buf::ByteBuf

pub struct ByteBuf { /* fields omitted */ }

A Buf backed by a contiguous region of memory.

This Buf is better suited for cases where there is a clear delineation between reading and writing.

Methods

impl ByteBuf

fn from_slice(bytes: &[u8]) -> ByteBuf

Create a new ByteBuf by copying the contents of the given slice.

fn mut_with_capacity(capacity: usize) -> MutByteBuf

fn none() -> ByteBuf

unsafe fn from_mem_ref(mem: MemRef, cap: u32, pos: u32, lim: u32) -> ByteBuf

fn capacity(&self) -> usize

fn flip(self) -> MutByteBuf

fn resume(self) -> MutByteBuf

Flips the buffer back to mutable, resetting the write position to the byte after the previous write.

fn read_slice(&mut self, dst: &mut [u8]) -> usize

fn to_seq_byte_str(self) -> SeqByteStr

fn to_bytes(self) -> Bytes

fn mark(&mut self)

Marks the current read location.

Together with reset, this can be used to read from a section of the buffer multiple times. The marked location will be cleared when the buffer is flipped.

fn reset(&mut self)

Resets the read position to the previously marked position.

Together with mark, this can be used to read from a section of the buffer multiple times.

Panics

This method will panic if no mark has been set.

Trait Implementations

impl Buf for ByteBuf

fn remaining(&self) -> usize

Returns the number of bytes that can be accessed from the Buf

fn bytes<'a>(&'a self) -> &'a [u8]

Returns a slice starting at the current Buf position and of length between 0 and Buf::remaining().

fn advance(&mut self, cnt: usize)

Advance the internal cursor of the Buf

fn read_slice(&mut self, dst: &mut [u8]) -> usize

Read bytes from the Buf into the given slice and advance the cursor by the number of bytes read. Returns the number of bytes read.

fn has_remaining(&self) -> bool

Returns true if there are any more bytes to consume

fn read_byte(&mut self) -> Option<u8>

Read a single byte from the Buf

impl Debug for ByteBuf

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Read for ByteBuf

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, Error>

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

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

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

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

Read the exact number of bytes required to fill buf.

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

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

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

fn chars(self) -> Chars<Self>

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

the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an Iterator over chars.

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

Creates an adaptor which will chain this stream with another.

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

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