Struct FixedSizeString

pub struct FixedSizeString<const CAP: usize>
where
    [(); { _ }]:,
{ /* private fields */ }

Fixed-size string buffer

Container for a string that can only contain a maximum of CAP bytes. The buffer is always 1-byte longer than CAP, to ensure the string is always null-terminated and can be used as a CStr.

Implementations

impl<const CAP: usize> FixedSizeString<CAP>

where [(); { _ }]:,

pub fn empty() -> Self

pub fn from_bytes(input: &[u8]) -> NWNParseResult<'_, Self>

Copies bytes from input into the container, ensuring UTF8 validity

pub fn from_bytes_lossy(input: &[u8]) -> NWNParseResult<'_, Self>

Copies bytes from input into the container, and returns an empty string if it contains non-utf8 characters

pub fn from_str(input: &str) -> Result<Self, &'static str>

Copies str bytes from input into the container. Fails if the str is too long

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

Returns a reference of the string bytes. The returned slice is always of length CAP, and may not be null-terminated.

pub fn as_str(&self) -> &str

Returns a reference to the stored string

pub fn as_c_str(&self) -> &CStr

Returns the stored string as a C string

pub fn set_str(&mut self, input: &str) -> Result<(), &'static str>

Sets the stored string. Fails if input is too long (in bytes)

pub fn len(&self) -> usize

Returns the length in bytes of the stored string

pub fn is_empty(&self) -> bool

Returns the length in bytes of the stored string

Trait Implementations

impl<const CAP: usize> Clone for FixedSizeString<CAP>

where [(); { _ }]:,

fn clone(&self) -> FixedSizeString<CAP>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const CAP: usize> Debug for FixedSizeString<CAP>

where [(); { _ }]:,

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

Formats the value using the given formatter.

impl<const CAP: usize> Default for FixedSizeString<CAP>

where [(); { _ }]:,

fn default() -> Self

Returns the “default value” for a type.

impl<'de, const CAP: usize> Deserialize<'de> for FixedSizeString<CAP>

where [(); { _ }]:,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const CAP: usize> Display for FixedSizeString<CAP>

where [(); { _ }]:,

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

Formats the value using the given formatter.

impl<const CAP: usize> FromStr for FixedSizeString<CAP>

where [(); { _ }]:,

fn from_str(input: &str) -> Result<Self, Self::Err>

Copies str bytes from input into the container. Fails if the str is too long

type Err = &'static str

The associated error which can be returned from parsing.

impl<const CAP: usize> PartialEq<&str> for FixedSizeString<CAP>

where [(); { _ }]:,

fn eq(&self, other: &&str) -> 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 CAP: usize> PartialEq<String> for FixedSizeString<CAP>

where [(); { _ }]:,

fn eq(&self, other: &String) -> 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 CAP: usize> PartialEq for FixedSizeString<CAP>

where [(); { _ }]:,

fn eq(&self, other: &FixedSizeString<CAP>) -> 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 CAP: usize> Serialize for FixedSizeString<CAP>

where [(); { _ }]:,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<const CAP: usize> Copy for FixedSizeString<CAP>

where [(); { _ }]:,

impl<const CAP: usize> StructuralPartialEq for FixedSizeString<CAP>

where [(); { _ }]:,