Struct Buffer 

pub struct Buffer<T>
where
    T: AsMut<[u8]> + AsRef<[u8]>,
{ /* private fields */ }

Implementations

impl<T> Buffer<T>

where T: AsMut<[u8]> + AsRef<[u8]>,

pub fn new(source: T) -> Buffer<T>

Create a new buffer from any source

Example

    use buffer::Buffer;
 
    let mut bytes = [0; 1024];
    let mut buffer = Buffer::new(&mut bytes);

pub fn reset(&mut self)

Reset the buffer to its initial state

pub fn capacity(&self) -> usize

Returns the length of the undelying buffer

pub fn remaining_capacity(&self) -> usize

Returns the remaining space that can be written This method does not perform a Buffer::shift

pub fn has_remaining_capacity(&self) -> bool

returns if there is remaining is equal to Buffer::remaining_capacity() > 0

pub fn remaining_len(&self) -> usize

Returns the remaining bayes to read

pub fn has_remaining_len(&self) -> bool

pub fn has_dead_capacity(&self) -> bool

Returns true if the read position is > 0

pub fn shift(&mut self)

Shifts the content of the source left to reuse space of read bytes.

pub fn ensure_remaining_capacity(&mut self) -> bool

Performa s Buffer::shift if there is no remianing capacity and returns if there is remainig capacity afterwards

pub fn create_reader_with_max(&mut self, max_bytes: usize) -> Reader<'_, T>

pub fn data(&self) -> &[u8]

Returns a slice containing the readable data

pub fn skip(&mut self, n: usize) -> Result<(), BufferError>

Skips n readable bytes

Errors

BufferError::NoData if n < self.remaining_len()

pub fn push(&mut self, buf: &[u8]) -> Result<(), BufferError>

Appends the provided slice to the buffer a a whole

Error

BufferError::NoCapacity if buf.len() > self.remaining_capacity()

Trait Implementations

impl<T> Clone for Buffer<T>

where T: AsMut<[u8]> + AsRef<[u8]> + Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Buffer<T>

where T: Debug + AsMut<[u8]> + AsRef<[u8]>,

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

Formats the value using the given formatter.

impl<T> ErrorType for Buffer<T>

where T: AsMut<[u8]> + AsRef<[u8]>,

type Error = ErrorKind

Error type of all the IO operations on this type.

impl<T> Read for Buffer<T>

where T: AsMut<[u8]> + AsRef<[u8]>,

fn read( &mut self, buf: &mut [u8], ) -> Result<usize, <Buffer<T> as ErrorType>::Error>

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

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

Read the exact number of bytes required to fill buf.

impl<T> ReadWrite for Buffer<T>

where T: AsMut<[u8]> + AsRef<[u8]>,

fn create_reader<'a>(&'a mut self) -> impl BufferReader + 'a

fn create_writer<'a>(&'a mut self) -> impl BufferWriter + 'a

impl<T> Write for Buffer<T>

where T: AsMut<[u8]> + AsRef<[u8]>,

fn write( &mut self, buf: &[u8], ) -> Result<usize, <Buffer<T> as ErrorType>::Error>

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

fn flush(&mut self) -> Result<(), <Buffer<T> as ErrorType>::Error>

Flush this output stream, blocking until all intermediately buffered contents reach their destination.

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

Write an entire buffer into this writer.

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

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