Struct LowerString 

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

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 LowerString

pub fn new(raw: String) -> Result<Self, <LowerString as Validator>::Error>

Constructs a new LowerString if it conforms to LowerString and normalizes the input

pub const unsafe fn new_unchecked(raw: String) -> Self

Constructs a new LowerString without validation or normalization

Safety

Consumers of this function must ensure that values conform to LowerString and are in normalized form. Failure to maintain this invariant may lead to undefined behavior.

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

Constructs a new LowerString from a static reference if it conforms to LowerString, normalizing the input

Panics

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

pub fn into_boxed_ref(self) -> Box<LowerStr>

Converts this LowerString into a Box<LowerStr>

This will drop any excess capacity.

pub fn take(self) -> String

Unwraps the underlying String value

Methods from Deref<Target = LowerStr>

pub 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 LowerString

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 Clone for LowerString

fn clone(&self) -> LowerString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LowerString

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

Formats the value using the given formatter.

impl Deref for LowerString

type Target = LowerStr

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for LowerString

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

Deserialize this value from the given Serde deserializer.

impl Display for LowerString

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

Formats the value using the given formatter.

impl<'ʄ> Facet<'ʄ> for LowerString

const SHAPE: &'static Shape

The shape of this type, including: whether it’s a Struct, an Enum, something else?

impl From<&LowerStr> for LowerString

fn from(s: &LowerStr) -> Self

Converts to this type from the input type.

impl From<Box<LowerStr>> for LowerString

fn from(r: Box<LowerStr>) -> Self

Converts to this type from the input type.

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

fn from(r: Cow<'a, 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<'a> From<LowerString> for Cow<'a, LowerStr>

fn from(owned: LowerString) -> Self

Converts to this type from the input type.

impl From<LowerString> for String

fn from(s: LowerString) -> Self

Converts to this type from the input type.

impl FromStr for LowerString

type Err = <LowerString as Validator>::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 Hash for LowerString

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 Normalizer for LowerString

fn normalize(s: &str) -> Result<Cow<'_, str>, Self::Error>

Validates and normalizes the borrowed input

impl Ord for LowerString

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 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 LowerString

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 PartialOrd for LowerString

fn partial_cmp(&self, other: &Self) -> 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 LowerString

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

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for LowerString

type Error = <LowerString as Validator>::Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for LowerString

type Error = <LowerString as Validator>::Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Validator for LowerString

type Error = InvalidString

The error produced when the string is invalid

fn validate(raw: &str) -> Result<(), Self::Error>

Validates a string according to a predetermined set of rules

impl Eq for LowerString

impl StructuralPartialEq for LowerString