Struct figment::value::Uncased

pub struct Uncased<'s> { /* fields omitted */ }

This is supported on crate feature alloc only.

An uncased (case-insensitive, case-preserving), owned or borrowed ASCII string.

Implementations

impl<'s> Uncased<'s>

pub fn new<S>(string: S) -> Uncased<'s> where
    S: Into<Cow<'s, str>>, 

Creates a new Uncased string from string without allocating.

Example

use uncased::Uncased;

let uncased = Uncased::new("Content-Type");
assert_eq!(uncased, "content-type");
assert_eq!(uncased, "CONTENT-Type");

pub const fn from_borrowed(string: &'s str) -> Uncased<'s>

Creates a new Uncased string from a borrowed string.

Example

use uncased::Uncased;

const UNCASED: Uncased = Uncased::from_borrowed("Content-Type");
assert_eq!(UNCASED, "content-type");
assert_eq!(UNCASED, "CONTENT-Type");

pub const fn from_owned(string: String) -> Uncased<'s>

Creates a new Uncased string from string without allocating.

Example

use uncased::Uncased;

const UNCASED: Uncased = Uncased::from_owned(String::new());

let uncased = Uncased::from_owned("Content-Type".to_string());
assert_eq!(uncased, "content-type");
assert_eq!(uncased, "CONTENT-Type");

pub fn as_uncased_str(&self) -> &UncasedStr

Converts self into an owned Uncased<'static>, allocating if necessary.

Example

use uncased::Uncased;

let foo = "foo".to_string();
let uncased = Uncased::from(foo.as_str());
let owned: Uncased<'static> = uncased.into_owned();
assert_eq!(owned, "foo");

pub fn into_string(self) -> String

Converts self into an owned String, allocating if necessary.

Example

use uncased::Uncased;

let uncased = Uncased::new("Content-Type");
let string = uncased.into_string();
assert_eq!(string, "Content-Type".to_string());

pub fn into_owned(self) -> Uncased<'static>

Converts self into an owned Uncased<'static>, allocating if necessary.

Example

use uncased::Uncased;

let foo = "foo".to_string();
let uncased = Uncased::from(foo.as_str());
let owned: Uncased<'static> = uncased.into_owned();
assert_eq!(owned, "foo");

pub fn into_boxed_uncased(self) -> Box<UncasedStr, Global>

Converts self into a Box<UncasedStr>.

Example

use uncased::Uncased;

let boxed = Uncased::new("Content-Type").into_boxed_uncased();
assert_eq!(&*boxed, "content-type");

Methods from Deref<Target = UncasedStr>

pub fn as_str(&self) -> &str

Returns self as an &str.

Example

use uncased::UncasedStr;

let uncased_str = UncasedStr::new("Hello!");
assert_eq!(uncased_str.as_str(), "Hello!");
assert_ne!(uncased_str.as_str(), "hELLo!");

pub fn len(&self) -> usize

Returns the length, in bytes, of self.

Example

use uncased::UncasedStr;

let uncased_str = UncasedStr::new("Hello!");
assert_eq!(uncased_str.len(), 6);

pub fn starts_with(&self, string: &str) -> bool

Returns true if self starts with any casing of the string string; otherwise, returns false.

Example

use uncased::UncasedStr;

let uncased_str = UncasedStr::new("MoOO");
assert!(uncased_str.starts_with("moo"));
assert!(uncased_str.starts_with("MOO"));
assert!(uncased_str.starts_with("MOOO"));
assert!(!uncased_str.starts_with("boo"));

let uncased_str = UncasedStr::new("Bèe");
assert!(!uncased_str.starts_with("Be"));
assert!(uncased_str.starts_with("Bè"));
assert!(uncased_str.starts_with("Bè"));
assert!(uncased_str.starts_with("bèe"));
assert!(uncased_str.starts_with("BèE"));

Trait Implementations

impl<'_> AsRef<[u8]> for Uncased<'_>

pub fn as_ref(&self) -> &[u8]

Performs the conversion.

impl<'_> AsRef<UncasedStr> for Uncased<'_>

pub fn as_ref(&self) -> &UncasedStr

Performs the conversion.

impl<'_> AsRef<str> for Uncased<'_>

pub fn as_ref(&self) -> &str

Performs the conversion.

impl<'_> Borrow<UncasedStr> for Uncased<'_>

pub fn borrow(&self) -> &UncasedStr

Immutably borrows from an owned value.

impl<'s> Clone for Uncased<'s>

pub fn clone(&self) -> Uncased<'s>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'s> Debug for Uncased<'s>

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

Formats the value using the given formatter.

impl<'_> Deref for Uncased<'_>

type Target = UncasedStr

The resulting type after dereferencing.

pub fn deref(&self) -> &UncasedStr

Dereferences the value.

impl<'_> Display for Uncased<'_>

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

Formats the value using the given formatter.

impl<'_> Eq for Uncased<'_>

impl<'s, 'c> From<&'c UncasedStr> for Uncased<'s> where
    'c: 's, 

pub fn from(string: &'c UncasedStr) -> Uncased<'s>

Performs the conversion.

impl<'s, 'c> From<&'c str> for Uncased<'s> where
    'c: 's, 

pub fn from(string: &'c str) -> Uncased<'s>

Performs the conversion.

impl<'s, 'c> From<Cow<'c, str>> for Uncased<'s> where
    'c: 's, 

pub fn from(string: Cow<'c, str>) -> Uncased<'s>

Performs the conversion.

impl From<String> for Uncased<'static>

pub fn from(string: String) -> Uncased<'static>

Performs the conversion.

impl<'_> Hash for Uncased<'_>

pub fn hash<H>(&self, hasher: &mut H) where
    H: Hasher, 

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'_> Ord for Uncased<'_>

pub fn cmp(&self, other: &Uncased<'_>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<'_, '_> PartialEq<&'_ str> for Uncased<'_>

pub fn eq(&self, other: &&str) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_, '_> PartialEq<String> for &'_ Uncased<'_>

pub fn eq(&self, other: &String) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<String> for Uncased<'_>

pub fn eq(&self, other: &String) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_, '_> PartialEq<Uncased<'_>> for Uncased<'_>

pub fn eq(&self, other: &Uncased<'_>) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<str> for Uncased<'_>

pub fn eq(&self, other: &str) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_, '_> PartialOrd<String> for &'_ Uncased<'_>

pub fn partial_cmp(&self, other: &String) -> Option<Ordering>

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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<'_> PartialOrd<String> for Uncased<'_>

pub fn partial_cmp(&self, other: &String) -> Option<Ordering>

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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<'_, '_> PartialOrd<Uncased<'_>> for Uncased<'_>

pub fn partial_cmp(&self, other: &Uncased<'_>) -> Option<Ordering>

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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<'_> PartialOrd<str> for Uncased<'_>

pub fn partial_cmp(&self, other: &str) -> Option<Ordering>

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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