Trait SocketBuffer

pub trait SocketBuffer:
    Clone
    + Debug
    + Default {
    // Required methods
    fn new() -> Self
       where Self: Sized;
    fn append_buffer(&mut self, buf: &[u8]);
    fn shift_left_buffer(&mut self, amount: usize);
    fn as_slice(&self) -> &[u8];
    fn len(&self) -> usize;

    // Provided methods
    fn clear(&mut self) { ... }
    fn is_empty(&self) -> bool { ... }
}

A trait for a buffer that can be used with a socket.

It can be used by either a read or write buffer of a socket.

Required Methods

fn new() -> Self

where Self: Sized,

Create a new buffer

fn append_buffer(&mut self, buf: &[u8])

Append a buffer to the end.

Arguments

• buf: buffer containing the data to be appended

fn shift_left_buffer(&mut self, amount: usize)

Shift the buffer to the left by amount

This is used to remove data from the buffer.

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

Get the buffer as a slice

Returns

• The buffer as a slice of bytes

fn len(&self) -> usize

Get the length of the buffer

Provided Methods

fn clear(&mut self)

Clear the buffer

fn is_empty(&self) -> bool

Check if the buffer is empty

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl SocketBuffer for Vec<u8>

fn new() -> Self

fn append_buffer(&mut self, buf: &[u8])

fn shift_left_buffer(&mut self, amount: usize)

fn len(&self) -> usize

fn clear(&mut self)

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

Implementors