Struct OctetsPtr 

pub struct OctetsPtr(/* private fields */);

A (safe) raw pointer to an pinned Octets.

Methods from Deref<Target = Octets<'static>>

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

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

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

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

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

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, BufferTooShortError>

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, BufferTooShortError>

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, BufferTooShortError>

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, BufferTooShortError>

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>, BufferTooShortError>

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>, BufferTooShortError>

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>, BufferTooShortError>

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>, BufferTooShortError>

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>, BufferTooShortError>

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

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

Returns a slice of len elements from the current offset.

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

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

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

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 Debug for OctetsPtr

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

Formats the value using the given formatter.

impl Deref for OctetsPtr

type Target = Octets<'static>

The resulting type after dereferencing.

fn deref(&self) -> &<OctetsPtr as Deref>::Target

Dereferences the value.

impl DerefMut for OctetsPtr

fn deref_mut(&mut self) -> &mut <OctetsPtr as Deref>::Target

Mutably dereferences the value.

impl From<&mut Octets<'_>> for OctetsPtr

fn from(value: &mut Octets<'_>) -> OctetsPtr

Converts to this type from the input type.

impl From<OctetsPtr> for BytesContent

fn from(value: OctetsPtr) -> Self

Converts to this type from the input type.

impl<CTP: ConnectionToPlugin> FromWithPH<OctetsPtr, CTP> for PluginVal

fn from_with_ph(value: OctetsPtr, ph: &mut PluginHandler<CTP>) -> Self