Struct ringtail::buffer::Buffer

pub struct Buffer<T> { /* fields omitted */ }

Growable ring buffer.

Optimized for repeated appending of bytes to the end and removing bytes from the front of the buffer.

Methods

impl<T: Copy> Buffer<T>

const DEFAULT_CAPACITY: usize

DEFAULT_CAPACITY: usize = 4096

fn new() -> Self

Create a new buffer with the default capacity.

fn with_capacity(capacity: usize) -> Self

Create a new buffer with a given minimum capacity pre-allocated.

fn is_empty(&self) -> bool

Returns true if the buffer is empty.

fn len(&self) -> usize

Returns the number of elements in the buffer.

fn capacity(&self) -> usize

Returns the current capacity of the buffer.

fn push(&mut self, src: &[T]) -> usize

Copy the given elements and insert them into the back of the buffer.

Returns the number of elements pushed.

fn pull(&mut self, dest: &mut [T]) -> usize

Pull bytes from the front of the buffer into the given location, up to the length of the destination buffer.

Returns the number of elements pulled.

fn copy_to(&self, dest: &mut [T]) -> usize

Copy elements from the front of the buffer into the given slice.

Returns the number of elements copied. If there are less elements in the buffer than the length of dest, then only part of dest will be written to.

fn consume(&mut self, count: usize) -> usize

Consume up to count elements from the front of the buffer and discards them.

Returns the number of elements consumed, which may be less than count if count was greater than the number of elements in the buffer.

This operation has a runtime cost of O(1).

fn clear(&mut self)

Remove all elements from the buffer.

Trait Implementations

impl<T: Clone> Clone for Buffer<T>

fn clone(&self) -> Buffer<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Copy> Default for Buffer<T>

fn default() -> Buffer<T>

Returns the "default value" for a type.

impl Read for Buffer<u8>

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.

unsafe fn initializer(&self) -> Initializer

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

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

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 [char]s.

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.

impl Write for Buffer<u8>

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

Write a buffer into this object, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

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

Attempts to write an entire buffer into this write.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

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

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