Struct ApiString 

pub struct ApiString { /* private fields */ }

A string type used in VPP API messages.

This represents a variable-length string with a length prefix, commonly used in VPP API message structures.

Note that copying/cloning ApiString objects will not copy/clone the contents of the string.

Implementations

impl ApiString

pub const fn len(&self) -> u32

Returns the length of the string in bytes.

pub const fn is_empty(&self) -> bool

Returns true if the string has a length of zero.

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

Returns a byte slice of the string’s contents.

pub fn to_str(&self) -> Result<&str, Utf8Error>

Converts the string to a &str slice.

If the contents of the ApiString are valid UTF-8 data, this function will return the corresponding &[str] slice. Otherwise, it will return an error with details of where UTF-8 validation failed.

pub fn to_string_lossy(&self) -> Cow<'_, str>

Converts the string to a Cow<str>, replacing invalid UTF-8 sequences with �.

pub unsafe fn set_len(&mut self, length: u32)

Sets the length of the string in bytes.

Safety

The caller must ensure that the underlying buffer has at least length bytes of valid memory and is initialised.

pub fn copy_from_str(&mut self, s: &str)

Copies the contents of the given string into this ApiString.

Panics

Panics if the length of the ApiString is different to the length of the string in bytes.

Trait Implementations

impl Clone for ApiString

fn clone(&self) -> ApiString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiString

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

Formats the value using the given formatter.

impl Default for ApiString

fn default() -> ApiString

Returns the “default value” for a type.

impl EndianSwap for ApiString

unsafe fn endian_swap(&mut self, _to_net: bool)

Swap the endianness of the message in-place.

impl Copy for ApiString