Struct Deque

pub struct Deque { /* private fields */ }

A fixed-capacity ring buffer for bytes

Implementations

impl Deque

pub fn new(capacity: usize) -> Self

pub fn capacity(&self) -> usize

pub fn remaining_capacity(&self) -> usize

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn clear(&mut self)

Resets the filled bytes in the buffer

Note that data is not actually wiped with this method. If that behavior is desired then calling Self::consume_filled should be preferred.

pub fn consume(&mut self, len: usize)

Consumes len bytes from the head of the buffer

Panics

len MUST be less than or equal to Self::len

pub fn filled(&mut self) -> Pair<&mut [u8]>

Returns the filled bytes in the buffer

pub fn consume_filled(&mut self, len: usize) -> Pair<&mut [u8]>

Returns and consumes len filled bytes in the buffer

Panics

len MUST be less than or equal to Self::len

pub fn unfilled(&mut self) -> Pair<&mut [MaybeUninit<u8>]>

Returns the unfilled bytes in the buffer

Callers will need to call Self::fill to indicate any writes that occurred to returned slices.

pub fn make_contiguous(&mut self) -> &mut [u8]

Makes the buffer contiguous and contained in a single slice

pub unsafe fn fill(&mut self, len: usize) -> Result<(), FillError>

Notifies the buffer that len bytes were written to it

Safety

Callers must ensure the filled bytes were actually initialized

Trait Implementations

impl Clone for Deque

fn clone(&self) -> Deque

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Deque

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

Formats the value using the given formatter.

impl From<Vec<u8>> for Deque

fn from(buffer: Vec<u8>) -> Deque

Converts to this type from the input type.

impl Storage for Deque

fn put_slice(&mut self, bytes: &[u8])

Writes a slice of bytes into the storage

fn put_uninit_slice<F, Error>( &mut self, payload_len: usize, f: F, ) -> Result<bool, Error>

where F: FnOnce(&mut UninitSlice) -> Result<(), Error>,

Tries to write into a uninit slice for the current storage

fn remaining_capacity(&self) -> usize

Returns the additional number of bytes that can be written to the storage

const SPECIALIZES_BYTES: bool = false

const SPECIALIZES_BYTES_MUT: bool = false

fn has_remaining_capacity(&self) -> bool

Returns true if the storage will accept any additional bytes

fn put_bytes(&mut self, bytes: Bytes)

Writes Bytes into the storage

fn put_bytes_mut(&mut self, bytes: BytesMut)

Writes BytesMut into the storage

fn put_chunk(&mut self, chunk: Chunk<'_>)

Writes a reader Chunk into the storage

fn with_write_limit(&mut self, max_len: usize) -> Limit<'_, Self>

Limits the number of bytes that can be written to the storage

fn track_write(&mut self) -> Tracked<'_, Self>

Tracks the number of bytes written to the storage

fn write_once(&mut self) -> WriteOnce<'_, Self>

Only allows a single write into the storage. After that, no more writes are allowed.

impl Storage for Deque

type Error = Infallible

fn buffered_len(&self) -> usize

Returns the length of the chunk

fn read_chunk(&mut self, watermark: usize) -> Result<Chunk<'_>, Self::Error>

Reads the current contiguous chunk

fn partial_copy_into<Dest>( &mut self, dest: &mut Dest, ) -> Result<Chunk<'_>, Self::Error>

where Dest: Storage + ?Sized,

Copies the reader into dest, with a trailing chunk of bytes.

fn copy_into<Dest>(&mut self, dest: &mut Dest) -> Result<(), Self::Error>

where Dest: Storage + ?Sized,

Copies the reader into dest.

fn buffer_is_empty(&self) -> bool

Returns if the chunk is empty

fn full_copy(&mut self) -> FullCopy<'_, Self>

Forces the entire reader to be copied, even when calling partial_copy_into.

fn track_read(&mut self) -> Tracked<'_, Self>

Tracks the number of bytes read from the storage