Struct LowerStr 

pub struct LowerStr(/* private fields */);

A borrowed reference to a non-empty, lowercase string A non-empty String normalized to lowercase

This type maintains an invariant that ensures that a value of this type cannot be constructed that contains invalid data. Data that can be normalized to a valid instance of this type will be.

Because this type does normalization, the type explicitly does not implement Borrow<str>, as doing so would could violate the contract of that trait, potentially resulting in lost data. If a user of the crate would like to override this, then they can explicitly implement the trait.

This type includes an explicit parameter indicating that the borrowed form of this type should be named LowerStr.

Implementations

impl LowerStr

pub fn from_normalized_str( raw: &str, ) -> Result<&Self, <LowerString as Validator>::Error>

Transparently reinterprets the string slice as a strongly-typed LowerStr if it conforms to LowerString, producing an error if normalization is necessary

pub const unsafe fn from_str_unchecked(raw: &str) -> &Self

Transparently reinterprets the string slice as a strongly-typed LowerStr without validating

Safety

Calls to this function must ensure that the value being passed conforms to LowerString and is already in normalized form. Failure to do this may result in undefined behavior if other code relies on this invariant.

pub fn from_static(raw: &'static str) -> &'static Self

Transparently reinterprets a static string slice as a strongly-typed LowerStr if it conforms to LowerString, normalizing if necessary

Panics

This function will panic if the provided raw string is not normalized.

pub fn from_str( raw: &str, ) -> Result<Cow<'_, Self>, <LowerString as Validator>::Error>

Transparently reinterprets the string slice as a strongly-typed LowerStr if it conforms to LowerString, normalizing if necessary

pub fn into_owned(self: Box<LowerStr>) -> LowerString

Converts a Box<LowerStr> into a LowerString without copying or allocating

pub const fn as_str(&self) -> &str

Provides access to the underlying value as a string slice.

Trait Implementations

impl AsRef<LowerStr> for LowerString

fn as_ref(&self) -> &LowerStr

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

impl AsRef<str> for LowerStr

fn as_ref(&self) -> &str

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

impl Borrow<LowerStr> for LowerString

fn borrow(&self) -> &LowerStr

Immutably borrows from an owned value.

impl Debug for LowerStr

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for &'a LowerStr

Deserializes a LowerStr in normalized form

This deserializer requires that the value already be in normalized form. If values may require normalization, then deserialized as LowerString or Cow<LowerStr> instead.

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

Deserialize this value from the given Serde deserializer.

impl<'de> Deserialize<'de> for Box<LowerStr>

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

Deserialize this value from the given Serde deserializer.

impl Display for LowerStr

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

Formats the value using the given formatter.

impl<'a, 'b: 'a> From<&'a Cow<'b, LowerStr>> for &'a LowerStr

fn from(r: &'a Cow<'b, LowerStr>) -> &'a LowerStr

Converts to this type from the input type.

impl From<&LowerStr> for Arc<LowerStr>

fn from(r: &LowerStr) -> Self

Converts to this type from the input type.

impl<'a> From<&'a LowerStr> for Cow<'a, LowerStr>

fn from(r: &'a LowerStr) -> Self

Converts to this type from the input type.

impl From<&LowerStr> for LowerString

fn from(s: &LowerStr) -> Self

Converts to this type from the input type.

impl From<&LowerStr> for Rc<LowerStr>

fn from(r: &LowerStr) -> Self

Converts to this type from the input type.

impl From<LowerString> for Box<LowerStr>

fn from(r: LowerString) -> Self

Converts to this type from the input type.

impl Hash for LowerStr

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

Feeds this value into the given Hasher.

impl Ord for LowerStr

fn cmp(&self, other: &LowerStr) -> Ordering

This method returns an Ordering between self and other.

impl PartialEq<&LowerStr> for LowerString

fn eq(&self, other: &&LowerStr) -> 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 PartialEq<LowerStr> for LowerString

fn eq(&self, other: &LowerStr) -> 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 PartialEq<LowerString> for &LowerStr

fn eq(&self, other: &LowerString) -> 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 PartialEq<LowerString> for LowerStr

fn eq(&self, other: &LowerString) -> 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 PartialEq for LowerStr

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

fn partial_cmp(&self, other: &LowerStr) -> 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 Serialize for LowerStr

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

Serialize this value into the given Serde serializer.

impl ToOwned for LowerStr

type Owned = LowerString

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl<'a> TryFrom<&'a str> for &'a LowerStr

type Error = <LowerString as Validator>::Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for LowerStr

impl StructuralPartialEq for LowerStr