Struct Octets

pub struct Octets<'a> { /* private fields */ }

A zero-copy immutable byte buffer.

Octets wraps an in-memory buffer of bytes and provides utility functions for manipulating it. The underlying buffer is provided by the user and is not copied when creating an Octets. Operations are panic-free and will avoid indexing the buffer past its end.

Additionally, an offset (initially set to the start of the buffer) is incremented as bytes are read from / written to the buffer, to allow for sequential operations.

Implementations

impl<'a> Octets<'a>

pub fn with_slice(buf: &'a [u8]) -> Self

Creates an Octets from the given slice, without copying.

Since the Octets is immutable, the input slice needs to be immutable.

pub fn get_u8(&mut self) -> Result<u8>

Reads an unsigned 8-bit integer from the current offset and advances the buffer.

pub fn peek_u8(&mut self) -> Result<u8>

Reads an unsigned 8-bit integer from the current offset without advancing the buffer.

pub fn get_u16(&mut self) -> Result<u16>

Reads an unsigned 16-bit integer in network byte-order from the current offset and advances the buffer.

pub fn get_u24(&mut self) -> Result<u32>

Reads an unsigned 24-bit integer in network byte-order from the current offset and advances the buffer.

pub fn get_u32(&mut self) -> Result<u32>

Reads an unsigned 32-bit integer in network byte-order from the current offset and advances the buffer.

pub fn get_u64(&mut self) -> Result<u64>

Reads an unsigned 64-bit integer in network byte-order from the current offset and advances the buffer.

pub fn get_varint(&mut self) -> Result<u64>

Reads an unsigned variable-length integer in network byte-order from the current offset and advances the buffer.

pub fn get_bytes(&mut self, len: usize) -> Result<Octets<'a>>

Reads len bytes from the current offset without copying and advances the buffer.

pub fn get_bytes_with_u8_length(&mut self) -> Result<Octets<'a>>

Reads len bytes from the current offset without copying and advances the buffer, where len is an unsigned 8-bit integer prefix.

pub fn get_bytes_with_u16_length(&mut self) -> Result<Octets<'a>>

Reads len bytes from the current offset without copying and advances the buffer, where len is an unsigned 16-bit integer prefix in network byte-order.

pub fn get_bytes_with_varint_length(&mut self) -> Result<Octets<'a>>

Reads len bytes from the current offset without copying and advances the buffer, where len is an unsigned variable-length integer prefix in network byte-order.

pub fn peek_bytes(&self, len: usize) -> Result<Octets<'a>>

Reads len bytes from the current offset without copying and without advancing the buffer.

pub fn slice(&self, len: usize) -> Result<&'a [u8]>

Returns a slice of len elements from the current offset.

pub fn slice_last(&self, len: usize) -> Result<&'a [u8]>

Returns a slice of len elements from the end of the buffer.

pub fn skip(&mut self, skip: usize) -> Result<()>

Advances the buffer’s offset.

pub fn cap(&self) -> usize

Returns the remaining capacity in the buffer.

pub fn len(&self) -> usize

Returns the total length of the buffer.

pub fn is_empty(&self) -> bool

Returns true if the buffer is empty.

pub fn off(&self) -> usize

Returns the current offset of the buffer.

pub fn buf(&self) -> &'a [u8]

Returns a reference to the internal buffer.

pub fn to_vec(&self) -> Vec<u8>

Copies the buffer from the current offset into a new Vec<u8>.

Trait Implementations

impl<'a> AsRef<[u8]> for Octets<'a>

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

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

impl<'a> Debug for Octets<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Octets<'a>

fn eq(&self, other: &Octets<'a>) -> 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<'a> Eq for Octets<'a>

impl<'a> StructuralPartialEq for Octets<'a>