Struct ZeroCopyStr

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

Implementations

impl<'a> ZeroCopyStr<'a>

pub fn write_to( str: &str, bytes: &'a mut [u8], ) -> (ZeroCopyStr<'a>, &'a mut [u8])

Writes the contents of a &str within the buffer provided. Requires space for the str byte length + LEN_TYPE_SIZE length.

We also return a new reference pointing just after the end of the str written.

Panics if buffer is not large enough.

pub fn write_to_update<'o>( str: &str, bytes: &'o mut &'a mut [u8], ) -> ZeroCopyStr<'a>

Writes the contents of a &str within the buffer provided. Requires space for the str byte length + LEN_TYPE_SIZE length.

We also update the position of the reference to just after the end of the str.

Panics if buffer is not large enough.

pub fn read_from(bytes: &mut &'a [u8]) -> ZeroCopyStr<'a>

Zero-copy deserializes bytes into ZeroCopyStr. Update the reference to point

We also update the position of the reference to just after the end of the str.

Panics if the buffer does not hold the proper data.

pub fn serialized_size(&self) -> usize

Total serialized size: str bytes + len bytes

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

Returns a view of the bytes of the inner &str.

Note this does not include the bytes of the str length

pub fn as_str(&self) -> &str

Returns a view of the inner &str

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

Serializes the str into a vec, in the format specified in this crate.

Trait Implementations

impl<'a> Clone for ZeroCopyStr<'a>

fn clone(&self) -> ZeroCopyStr<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ZeroCopyStr<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a str> for ZeroCopyStr<'a>

fn from(value: &'a str) -> Self

Converts to this type from the input type.

impl<'a> PartialEq<&str> for ZeroCopyStr<'a>

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

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

const 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> PartialEq for ZeroCopyStr<'a>

fn eq(&self, other: &ZeroCopyStr<'a>) -> bool

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

const 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> Copy for ZeroCopyStr<'a>

impl<'a> StructuralPartialEq for ZeroCopyStr<'a>