Struct tinystr::unvalidated::UnvalidatedTinyAsciiStr

pub struct UnvalidatedTinyAsciiStr<const N: usize>(pub(crate) [u8; N]);

A fixed-length bytes array that is expected to be an ASCII string but does not enforce that invariant.

Use this type instead of TinyAsciiStr if you don’t need to enforce ASCII during deserialization. For example, strings that are keys of a map don’t need to ever be reified as TinyAsciiStrs.

The main advantage of this type over [u8; N] is that it serializes as a string in human-readable formats like JSON.

Tuple Fields

0: [u8; N]

Implementations

impl<const N: usize> UnvalidatedTinyAsciiStr<N>

pub fn try_into_tinystr(&self) -> Result<TinyAsciiStr<N>, TinyStrError>

Trait Implementations

impl<const N: usize> AsULE for UnvalidatedTinyAsciiStr<N>

type ULE = UnvalidatedTinyAsciiStr<N>

The ULE type corresponding to Self.

fn to_unaligned(self) -> Self::ULE

Converts from Self to Self::ULE.

fn from_unaligned(unaligned: Self::ULE) -> Self

Converts from Self::ULE to Self.

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

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

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

Formats the value using the given formatter.

impl<const N: usize> From<TinyAsciiStr<N>> for UnvalidatedTinyAsciiStr<N>

fn from(other: TinyAsciiStr<N>) -> Self

Converts to this type from the input type.

impl<const N: usize> Ord for UnvalidatedTinyAsciiStr<N>

fn cmp(&self, other: &UnvalidatedTinyAsciiStr<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 + PartialOrd,

Restrict a value to a certain interval.

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

fn eq(&self, other: &UnvalidatedTinyAsciiStr<N>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const N: usize> PartialOrd for UnvalidatedTinyAsciiStr<N>

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<const N: usize> ULE for UnvalidatedTinyAsciiStr<N>

fn validate_byte_slice(bytes: &[u8]) -> Result<(), ZeroVecError>

Validates a byte slice, &[u8].

fn parse_byte_slice(bytes: &[u8]) -> Result<&[Self], ZeroVecError>

Parses a byte slice, &[u8], and return it as &[Self] with the same lifetime.

unsafe fn from_byte_slice_unchecked(bytes: &[u8]) -> &[Self]

Takes a byte slice, &[u8], and return it as &[Self] with the same lifetime, assuming that this byte slice has previously been run through Self::parse_byte_slice() with success.

fn as_byte_slice(slice: &[Self]) -> &[u8]

Given &[Self], returns a &[u8] with the same lifetime.

impl<'a, const N: usize> ZeroMapKV<'a> for UnvalidatedTinyAsciiStr<N>

type Container = ZeroVec<'a, UnvalidatedTinyAsciiStr<N>>

The container that can be used with this type: ZeroVec or VarZeroVec.

type Slice = ZeroSlice<UnvalidatedTinyAsciiStr<N>>

type GetType = UnvalidatedTinyAsciiStr<N>

The type produced by Container::get()

type OwnedType = UnvalidatedTinyAsciiStr<N>

The type produced by Container::replace() and Container::remove(), also used during deserialization. If Self is human readable serialized, deserializing to Self::OwnedType should produce the same value once passed through Self::owned_as_self()

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

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

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