Struct FixedString

pub struct FixedString<const N: usize>(/* private fields */);

A string with a maximum capacity of len <= N.

Implementations

impl<const N: usize> FixedString<N>

pub fn new(string: String) -> Result<Self, EncodeError>

pub unsafe fn new_unchecked(string: String) -> Self

Safety

This function is unsafe because it does not check if the string is longer than the maximum length.

pub fn into_inner(self) -> String

Trait Implementations

impl<const N: usize> AsRef<str> for FixedString<N>

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

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

fn clone(&self) -> FixedString<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 FixedString<N>

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

Formats the value using the given formatter.

impl<const N: usize> Decode for FixedString<N>

fn decode(data: impl IntoIterator<Item = u8>) -> Result<Self, DecodeError>

where Self: Sized,

impl<const N: usize> Display for FixedString<N>

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

Formats the value using the given formatter.

impl<const N: usize> Encode for FixedString<N>

fn encode(&self) -> Result<Vec<u8>, EncodeError>

Encodes a structure into a byte sequence.

fn into_encoded(self) -> Result<Vec<u8>, EncodeError>

where Self: Sized,

impl<const N: usize> FromStr for FixedString<N>

type Err = EncodeError

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl<const N: usize> Hash for FixedString<N>

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> Ord for FixedString<N>

fn cmp(&self, other: &FixedString<N>) -> 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> PartialEq for FixedString<N>

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

fn partial_cmp(&self, other: &FixedString<N>) -> 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> TryFrom<&str> for FixedString<N>

type Error = EncodeError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<FixedString<N>, EncodeError>

Performs the conversion.

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

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