Struct ApiFixedString 

pub struct ApiFixedString<const N: usize> { /* private fields */ }

A string type used in VPP API messages.

This represents a fixed-length, nul-terminated string, commonly used in VPP API message structures.

Implementations

impl<const N: usize> ApiFixedString<N>

pub const fn len(&self) -> usize

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 not including the nul-terminator.

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

Converts the string to a &str slice.

If the contents of the ApiFixedString 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 fn copy_from_str(&mut self, s: &str)

Copies the contents of the given string into this ApiFixedString.

Panics

Panics if the string exceeds the capacity of the fixed buffer.

Trait Implementations

impl<const N: usize> Clone for ApiFixedString<N>

fn clone(&self) -> ApiFixedString<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for ApiFixedString<N>

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

Formats the value using the given formatter.

impl<const N: usize> Default for ApiFixedString<N>

fn default() -> Self

Returns the “default value” for a type.

impl<const N: usize> EndianSwap for ApiFixedString<N>

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

Swap the endianness of the message in-place.

impl<const N: usize> PartialEq for ApiFixedString<N>

fn eq(&self, other: &ApiFixedString<N>) -> 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<const N: usize> Copy for ApiFixedString<N>

impl<const N: usize> Eq for ApiFixedString<N>

impl<const N: usize> StructuralPartialEq for ApiFixedString<N>