Trait Buffer 

pub trait Buffer {
    type Freeze;

    // Required methods
    fn with_capacity(capacity: usize) -> Self
       where Self: Sized;
    fn is_empty(&self) -> bool;
    fn len(&self) -> usize;
    unsafe fn extend_from_slice(&mut self, src: &[u8]);
    fn reserve(&mut self, additional: usize);
    fn freeze(self) -> Self::Freeze;
    unsafe fn advance(&mut self, cnt: usize);
    unsafe fn buf_ptr(&mut self) -> *mut u8;

    // Provided method
    fn extend(&mut self, src: &str) { ... }
}

Minimal Buffer trait with utf-8 safety

Required Associated Types

type Freeze

Into immutable type

Required Methods

fn with_capacity(capacity: usize) -> Self

where Self: Sized,

Returns new Buffer with capacity

fn is_empty(&self) -> bool

Returns true if the Buffer has a length of 0.

fn len(&self) -> usize

unsafe fn extend_from_slice(&mut self, src: &[u8])

Appends given bytes to this Buffer.

Safety

Broke utf-8 safety

Panics

Can panic if current length plus src length overflows usize

fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more bytes to be inserted into the given Buffer.

Panics

Can panic if current capacity plus additional overflows usize

fn freeze(self) -> Self::Freeze

Converts self into a Freeze type

unsafe fn advance(&mut self, cnt: usize)

Advance the internal cursor of the Buffer

Safety

Can’t advance more than capacity of the Buffer

Panics

Can panic if length plus cnt is bigger than capacity

unsafe fn buf_ptr(&mut self) -> *mut u8

Return unsafe ptr to current Buffer position

Safety

If buffer is full, can return invalid pointer

Provided Methods

fn extend(&mut self, src: &str)

Appends given str to this Buffer.

Panics

Can panic if current length plus src length overflows usize

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl Buffer for String

type Freeze = String

fn with_capacity(capacity: usize) -> Self

where Self: Sized,

fn is_empty(&self) -> bool

fn len(&self) -> usize

unsafe fn extend_from_slice(&mut self, src: &[u8])

fn reserve(&mut self, additional: usize)

fn freeze(self) -> Self::Freeze

unsafe fn advance(&mut self, cnt: usize)

unsafe fn buf_ptr(&mut self) -> *mut u8

impl Buffer for Vec<u8>

type Freeze = Vec<u8>

fn with_capacity(capacity: usize) -> Self

where Self: Sized,

fn is_empty(&self) -> bool

fn len(&self) -> usize

unsafe fn extend_from_slice(&mut self, src: &[u8])

fn reserve(&mut self, additional: usize)

fn freeze(self) -> Self::Freeze

unsafe fn advance(&mut self, cnt: usize)

unsafe fn buf_ptr(&mut self) -> *mut u8

Implementors

impl Buffer for buf_min::ntex::BytesMut

type Freeze = Bytes

impl Buffer for buf_min::tokio_bytes::BytesMut

type Freeze = Bytes