Struct FixStr

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

Implementations

impl<const N: usize> FixStr<N>

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

Creates a new FixStr if the input fits within capacity.

Returns None if the string is too long (> N octets) or exceeds u8::MAX.

pub fn new_unchecked(s: &str) -> Self

Creates a new FixStr without capacity checking.

Panics

Panics if the string is too long for the fixed capacity.

pub fn as_str(&self) -> &str

Returns a string slice containing the entire string.

Safety

Safe because we only store valid UTF-8 strings.

pub fn char_len(&self) -> usize

Returns the length of the string in Unicode characters.

This may be different from the octet length for non-ASCII strings.

pub fn len(&self) -> usize

Returns the length of the string in octets.

pub fn is_empty(&self) -> bool

Returns true if the string is empty.

pub fn capacity(&self) -> usize

Returns the total capacity in octets.

Trait Implementations

impl<const N: usize> AsRef<str> for FixStr<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 FixStr<N>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

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

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

Formats the value using the given formatter.

impl<const N: usize> From<FixStr<N>> for String

fn from(s: FixStr<N>) -> Self

Converts to this type from the input type.

impl<const N: usize> Hash for FixStr<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 FixStr<N>

fn cmp(&self, other: &FixStr<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 FixStr<N>

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

fn partial_cmp(&self, other: &FixStr<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 FixStr<N>

type Error = String

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const N: usize> TryFrom<String> for FixStr<N>

type Error = String

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.

impl<const N: usize> Copy for FixStr<N>

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

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