Skip to main content

Buffer

Struct Buffer 

Source
pub struct Buffer { /* private fields */ }
Expand description

A byte buffer from a pool: a fixed capacity (its size class) and a filled length.

§Examples

use net_io::{BufferPool, SizeClass};
let mut pool = BufferPool::standalone(1 << 20);
let mut buf = pool.take(SizeClass::SMALL).unwrap();
buf.spare()[..5].copy_from_slice(b"hello");
buf.set_len(5);
assert_eq!(buf.as_slice(), b"hello");
pool.put(buf);

Implementations§

Source§

impl Buffer

Source

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

The filled part.

Source

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

The filled part, mutable.

Source

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

The unfilled tail.

Source

pub fn len(&self) -> usize

The filled length.

Source

pub fn is_empty(&self) -> bool

Whether nothing is filled.

Source

pub fn set_len(&mut self, n: usize)

Sets the filled length; saturates at the capacity.

Source

pub fn capacity(&self) -> usize

The capacity in bytes.

Source

pub fn class(&self) -> SizeClass

The size class.

Source

pub fn clear(&mut self)

Empties the buffer (does not wipe; the pool wipes on release).

Trait Implementations§

Source§

impl Debug for Buffer

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.