Struct Buffer

pub struct Buffer { /* private fields */ }

A byte buffer (e.g. Vec<u8>).

Implementations

impl Buffer

pub fn new() -> Buffer

Create a new empty buffer.

pub fn with_capacity(capacity: usize) -> Buffer

Create a new buffer with the provided size.

pub fn len(&self) -> usize

How many bytes are in this buffer?

pub fn is_empty(&self) -> bool

Is the buffer empty?

pub fn into_raw(self) -> *mut signal_buffer

Extract the underlying raw pointer.

Note

It is the user’s responsibility to ensure the buffer is later free’d (e.g. with Buffer::from_raw or sys::signal_buffer_free).

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

Get an immutable reference to the underlying data.

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

Get a mutable reference to the underlying data.

pub fn append(&mut self, data: &[u8])

Append some data to this buffer.

Note

Every append results in a re-allocation of the underlying buffer.

Trait Implementations

impl AsMut<[u8]> for Buffer

fn as_mut(&mut self) -> &mut [u8]

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[u8]> for Buffer

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

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Buffer

fn clone(&self) -> Buffer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Buffer

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

Formats the value using the given formatter.

impl Default for Buffer

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Buffer

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> From<&'a [u8]> for Buffer

fn from(other: &'a [u8]) -> Buffer

Converts to this type from the input type.

impl From<Vec<u8>> for Buffer

fn from(other: Vec<u8>) -> Buffer

Converts to this type from the input type.

impl<T> Index<T> for Buffer

where [u8]: Index<T>,

type Output = <[u8] as Index<T>>::Output

The returned type after indexing.

fn index(&self, ix: T) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<T> for Buffer

where [u8]: IndexMut<T>,

fn index_mut(&mut self, ix: T) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl Ord for Buffer

fn cmp(&self, other: &Buffer) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Buffer

fn eq(&self, other: &Buffer) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Buffer

fn partial_cmp(&self, other: &Buffer) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Write for Buffer

fn write(&mut self, data: &[u8]) -> Result<usize>

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

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

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

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

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.

impl Eq for Buffer