Buffer

peekable::buffer

Trait Buffer

pub trait Buffer {
    // Required methods
    fn new() -> Self
       where Self: Sized;
    fn with_capacity(capacity: usize) -> Self
       where Self: Sized;
    fn consume(&mut self, rng: RangeTo<usize>);
    fn clear(&mut self);
    fn resize(&mut self, len: usize) -> Result<()>;
    fn truncate(&mut self, len: usize);
    fn extend_from_slice(&mut self, other: &[u8]) -> Result<()>;
    fn as_slice(&self) -> &[u8] ⓘ;
    fn as_mut_slice(&mut self) -> &mut [u8] ⓘ;
    fn len(&self) -> usize;
    fn is_empty(&self) -> bool;
    fn capacity(&self) -> usize;
}

Expand description

A trait for types that can be used as a buffer in the Peekable and AsyncPeekable reader.

Required Methods§

fn new() -> Self
where Self: Sized,

Create a new empty buffer.

fn with_capacity(capacity: usize) -> Self
where Self: Sized,

Create a new buffer with the specified capacity.

fn consume(&mut self, rng: RangeTo<usize>)

Consume the range from the buffer, the remaining elements are shifted to the left.

fn clear(&mut self)

Remove all elements from the buffer.

fn resize(&mut self, len: usize) -> Result<()>

Resizes the buffer so that its length is equal to len.

fn truncate(&mut self, len: usize)

Shorten the buffer, keeping the first len elements and dropping the rest.

fn extend_from_slice(&mut self, other: &[u8]) -> Result<()>

Copy elements from a slice and append them to the buffer.

fn as_slice(&self) -> &[u8] ⓘ

Returns a slice of the buffer.

fn as_mut_slice(&mut self) -> &mut [u8] ⓘ

Returns a mutable slice of the buffer.

fn len(&self) -> usize

Returns the length of the buffer.

fn is_empty(&self) -> bool

Returns true if the buffer is empty.

fn capacity(&self) -> usize

Returns the capacity of the buffer.

Implementations on Foreign Types§

impl Buffer for Vec<u8>

fn new() -> Self

fn with_capacity(capacity: usize) -> Self

fn consume(&mut self, rng: RangeTo<usize>)

fn clear(&mut self)

fn resize(&mut self, len: usize) -> Result<()>

fn truncate(&mut self, len: usize)

fn extend_from_slice(&mut self, other: &[u8]) -> Result<()>

fn as_slice(&self) -> &[u8] ⓘ

fn as_mut_slice(&mut self) -> &mut [u8] ⓘ

fn len(&self) -> usize

fn is_empty(&self) -> bool

fn capacity(&self) -> usize

impl<A> Buffer for SmallVec<A>
where A: Array<Item = u8>,

Available on crate feature smallvec only.

fn new() -> Self
where Self: Sized,

fn with_capacity(capacity: usize) -> Self
where Self: Sized,

fn consume(&mut self, rng: RangeTo<usize>)

fn clear(&mut self)

fn resize(&mut self, len: usize) -> Result<()>

fn truncate(&mut self, len: usize)

fn extend_from_slice(&mut self, other: &[u8]) -> Result<()>

fn as_slice(&self) -> &[u8] ⓘ

fn as_mut_slice(&mut self) -> &mut [u8] ⓘ

fn len(&self) -> usize

fn is_empty(&self) -> bool

fn capacity(&self) -> usize

impl<A: Array<Item = u8>> Buffer for TinyVec<A>

Available on crate feature tinyvec only.

fn new() -> Self
where Self: Sized,

fn with_capacity(capacity: usize) -> Self
where Self: Sized,

fn consume(&mut self, rng: RangeTo<usize>)

fn clear(&mut self)

fn resize(&mut self, len: usize) -> Result<()>

fn truncate(&mut self, len: usize)

fn extend_from_slice(&mut self, other: &[u8]) -> Result<()>

fn as_slice(&self) -> &[u8] ⓘ

fn as_mut_slice(&mut self) -> &mut [u8] ⓘ

fn len(&self) -> usize

fn is_empty(&self) -> bool

fn capacity(&self) -> usize

Implementors§