Struct FixedStr 

pub struct FixedStr<const N: usize, Alignment> { /* private fields */ }

Fixed stack-allocated string

The characters are stored within FixedStr’s internal buffer. It is suitable for any fixed-length data having a valid UTF-8 representation. Common uses for FixedStr include identifiers and hashes.

Unlike BoundedStr, the length is not encoded and is assumed to match the capacity N. However, if the string is shorter than N, the remaining bytes will be NUL-padded.

Aliases

See also: FStr8, FStr16, FStr24, FStr32, FStr64, FStr128

Implementations

impl<const N: usize, Alignment> FixedStr<N, Alignment>

pub const fn new() -> Self

Creates a NUL-padded FixedStr. Equivalent to FixedStr::default().

pub const unsafe fn from_bytes(data: [u8; N]) -> Self

Safety

This function requires that the provided bytes can be represented by a UTF-8 string. Otherwise, Self::as_str and Self::as_str_trimmed are not well-defined.

pub fn try_from(s: &str) -> Result<Self, ExceedsCapacity>

It is possible to construct a FixedStr shorter than its capacity, in which case the missing bytes will be filled with NULs.

pub const fn const_from(s: &str) -> Self

Builds FixedStr within a const context

pub const fn const_try_from(s: &str) -> Option<Self>

Attempts to build FixedStr within a const context

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

Returns underlying byte buffer

pub fn as_str(&self) -> &str

Converts FixedStr to &str

pub fn as_str_trimmed(&self) -> &str

Converts FixedStr to a &str. If the value is NUL-padded or contains NULs, this stops at the first NUL byte.

pub fn to_string_trimmed(&self) -> String

Converts FixedStr to a String. If the value is NUL-padded or contains NULs, this stops at the first NUL byte.

Trait Implementations

impl<const N: usize, Alignment: Clone> Clone for FixedStr<N, Alignment>

fn clone(&self) -> FixedStr<N, Alignment>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize, Alignment> Debug for FixedStr<N, Alignment>

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

Formats the value using the given formatter.

impl<const N: usize, Alignment> Default for FixedStr<N, Alignment>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, const N: usize, Alignment> Deserialize<'de> for FixedStr<N, Alignment>

Available on crate feature serde only.

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const N: usize, Alignment> Display for FixedStr<N, Alignment>

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

Formats the value using the given formatter.

impl<const N: usize, Alignment> From<&String> for FixedStr<N, Alignment>

Available on crate feature std only.

fn from(s: &String) -> Self

Converts to this type from the input type.

impl<const N: usize, Alignment> From<&str> for FixedStr<N, Alignment>

fn from(s: &str) -> Self

Converts to this type from the input type.

impl<const N: usize, Alignment> From<String> for FixedStr<N, Alignment>

Available on crate feature std only.

fn from(s: String) -> Self

Converts to this type from the input type.

impl<const N: usize, Alignment: Hash> Hash for FixedStr<N, Alignment>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<const N: usize, Alignment: Ord> Ord for FixedStr<N, Alignment>

fn cmp(&self, other: &FixedStr<N, Alignment>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<const N: usize, Alignment: PartialEq> PartialEq for FixedStr<N, Alignment>

fn eq(&self, other: &FixedStr<N, Alignment>) -> 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, Alignment: PartialOrd> PartialOrd for FixedStr<N, Alignment>

fn partial_cmp(&self, other: &FixedStr<N, Alignment>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const N: usize, Alignment> Serialize for FixedStr<N, Alignment>

Available on crate feature serde only.

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<const N: usize, Alignment: Copy> Copy for FixedStr<N, Alignment>

impl<const N: usize, Alignment: Eq> Eq for FixedStr<N, Alignment>

impl<const N: usize, Alignment> StructuralPartialEq for FixedStr<N, Alignment>