Struct Check

#[repr(transparent)]
pub struct Check<I: Invariant, B: AsRef<str> + 'static = String> {
    pub(crate) _marker: PhantomData<I>,
    pub(crate) buf: B,
}

Owned immutable string with invariants.

Similar to how String derefs to &str, Check derefs to &Ck. This means APIs requiring &Check<I> as an argument should instead consider accepting &Ck<I> for more flexibility.

Buffers

By default, this type is backed by a String, but it can also be backed by any AsRef<str> + 'static type. In particular, types like SmolStr are good candidates since they’re designed to be immutable.

It’s recommended to use a type alias when using a custom backing type, since extra generics can make the type signature long.

Fields

_marker: PhantomData<I>

buf: B

Implementations

impl<I: Invariant, B: AsRef<str>> Check<I, B>

pub fn from_buf(buf: B) -> Result<Self, I::Error>

Returns an Ok if the buffer upholds the invariants, otherwise Err.

pub unsafe fn from_buf_unchecked(buf: B) -> Self

Create a new Check without validating the buffer.

Safety

The buffer must contain a valid string.

pub fn as_ck(&self) -> &Ck<I>

Returns a &Ck that borrows from self.

pub fn into_inner(self) -> B

Returns the inner representation.

Methods from Deref<Target = Ck<I>>

pub fn to_check<'a, B>(&'a self) -> Check<I, B>

where B: AsRef<str> + From<&'a str>,

Returns an owned Check from &self.

pub fn as_str(&self) -> &str

Returns the &str representation.

Trait Implementations

impl<I: Invariant, B: AsRef<str>> AsRef<Ck<I>> for Check<I, B>

fn as_ref(&self) -> &Ck<I>

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

impl<I: Invariant, B: AsRef<str>> AsRef<str> for Check<I, B>

fn as_ref(&self) -> &str

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

impl<I: Invariant, B: AsRef<str>> Borrow<Ck<I>> for Check<I, B>

fn borrow(&self) -> &Ck<I>

Immutably borrows from an owned value.

impl<I: Clone + Invariant, B: Clone + AsRef<str> + 'static> Clone for Check<I, B>

fn clone(&self) -> Check<I, B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I, B> Debug for Check<I, B>

where I: Invariant, B: AsRef<str> + Debug,

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

Formats the value using the given formatter.

impl<I: Invariant, B: AsRef<str>> Deref for Check<I, B>

type Target = Ck<I>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<I: Invariant, B: AsRef<str>> Display for Check<I, B>

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

Formats the value using the given formatter.

impl<'a, I: Invariant, B: AsRef<str>> From<&'a Check<I, B>> for &'a Ck<I>

fn from(check: &'a Check<I, B>) -> Self

Converts to this type from the input type.

impl<'a, I, B> From<&'a Ck<I>> for Check<I, B>

where I: Invariant, B: AsRef<str> + From<&'a str>,

fn from(check: &'a Ck<I>) -> Self

Converts to this type from the input type.

impl<I, B> FromStr for Check<I, B>

where I: Invariant, for<'a> B: AsRef<str> + From<&'a str>,

type Err = <I as Invariant>::Error

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<I: Invariant, B: AsRef<str>> Hash for Check<I, B>

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<I: Invariant, B: AsRef<str>> Ord for Check<I, B>

fn cmp(&self, other: &Self) -> 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<'a, I: Invariant, B: AsRef<str>> PartialEq<&'a Check<I, B>> for Ck<I>

fn eq(&self, other: &&'a Check<I, B>) -> 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<'a, I: Invariant, B: AsRef<str>> PartialEq<&'a Check<I, B>> for String

fn eq(&self, other: &&'a Check<I, B>) -> 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<'a, I: Invariant, B: AsRef<str>> PartialEq<&'a Check<I, B>> for str

fn eq(&self, other: &&'a Check<I, B>) -> 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<'a, I, B1, B2> PartialEq<&'a Check<I, B2>> for Check<I, B1>

where I: Invariant, B1: AsRef<str>, B2: AsRef<str>,

fn eq(&self, other: &&'a Check<I, B2>) -> 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<'a, I: Invariant, B: AsRef<str>> PartialEq<&'a Ck<I>> for Check<I, B>

fn eq(&self, other: &&'a Ck<I>) -> 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<'a, I: Invariant, B: AsRef<str>> PartialEq<&'a String> for Check<I, B>

fn eq(&self, other: &&'a 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<'a, I: Invariant, B: AsRef<str>> PartialEq<&'a str> for Check<I, B>

fn eq(&self, other: &&'a 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<'a, I: Invariant, B: AsRef<str>> PartialEq<Check<I, B>> for &'a Ck<I>

fn eq(&self, other: &Check<I, B>) -> 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<'a, I: Invariant, B: AsRef<str>> PartialEq<Check<I, B>> for &'a String

fn eq(&self, other: &Check<I, B>) -> 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<'a, I: Invariant, B: AsRef<str>> PartialEq<Check<I, B>> for &'a str

fn eq(&self, other: &Check<I, B>) -> 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<I: Invariant, B: AsRef<str>> PartialEq<Check<I, B>> for Ck<I>

fn eq(&self, other: &Check<I, B>) -> 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<I: Invariant, B: AsRef<str>> PartialEq<Check<I, B>> for String

fn eq(&self, other: &Check<I, B>) -> 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<I: Invariant, B: AsRef<str>> PartialEq<Check<I, B>> for str

fn eq(&self, other: &Check<I, B>) -> 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<'a, I, B1, B2> PartialEq<Check<I, B2>> for &'a Check<I, B1>

where I: Invariant, B1: AsRef<str>, B2: AsRef<str>,

fn eq(&self, other: &Check<I, B2>) -> 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<I, B1, B2> PartialEq<Check<I, B2>> for Check<I, B1>

where I: Invariant, B1: AsRef<str>, B2: AsRef<str>,

fn eq(&self, other: &Check<I, B2>) -> 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<'a, I: Invariant, B: AsRef<str>> PartialEq<Ck<I>> for &'a Check<I, B>

fn eq(&self, other: &Ck<I>) -> 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<I: Invariant, B: AsRef<str>> PartialEq<Ck<I>> for Check<I, B>

fn eq(&self, other: &Ck<I>) -> 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<'a, I: Invariant, B: AsRef<str>> PartialEq<String> for &'a Check<I, B>

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<I: Invariant, B: AsRef<str>> PartialEq<String> for Check<I, B>

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<'a, I: Invariant, B: AsRef<str>> PartialEq<str> for &'a Check<I, B>

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<I: Invariant, B: AsRef<str>> PartialEq<str> for Check<I, B>

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<I, B1, B2> PartialOrd<Check<I, B2>> for Check<I, B1>

where I: Invariant, B1: AsRef<str>, B2: AsRef<str>,

fn partial_cmp(&self, other: &Check<I, B2>) -> 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<I: Invariant, B: AsRef<str>> Eq for Check<I, B>