Struct sub_strs::CainStr

pub struct CainStr<'a> { /* fields omitted */ }

Case-insensitive string

Notes

• This struct is intended for sorting in lists, or to be used in sets, so it generates a lower-case form of source string and stores it inside. That might look like a waste of memory, but it helps with performance. For example when you call Vec::sort() or when you insert it into a HashSet, it doesn't have to generate any string again and again...
• Implementations of From<&'a str>, From<&'a String> and From<String> either borrow or take the source string and store it inside.
• Implementation of FromStr will clone the source strings.

Examples

use std::collections::HashSet;
use sub_strs::CainStr;

let wild_data: HashSet<_> = vec!["swift", "C++", "rust", "SWIFT"].into_iter().collect();
assert_eq!(wild_data.len(), 4);

let data: HashSet<_> = wild_data.into_iter().map(|s| CainStr::from(s)).collect();
assert_eq!(data.len(), 3);

let mut data: Vec<_> = data.into_iter().collect();
data.sort();
let data: Vec<_> = data.iter().map(|cs| cs.as_ref()).collect();
assert_eq!(&data[..2], &["C++", "rust"]);
assert!(data[2].eq_ignore_ascii_case("swift"));

Methods

impl<'_> CainStr<'_>

pub fn lowercase(&self) -> &str

Gets the lowercase form of source string

pub fn into_lowercase(self) -> String

Converts self into the lowercase form of source string

This function simply takes the inner field out. There is no allocation.

Trait Implementations

impl<'_> PartialOrd<CainStr<'_>> for CainStr<'_>

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

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

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

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

#[must_use] 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] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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<'_> PartialEq<CainStr<'_>> for CainStr<'_>

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

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

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

This method tests for !=.

impl<'_> Ord for CainStr<'_>

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

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

fn as_ref(&self) -> &str

Performs the conversion.

impl<'a> Eq for CainStr<'a>

impl<'a> From<&'a str> for CainStr<'a>

fn from(src: &'a str) -> Self

Performs the conversion.

impl<'a> From<&'a String> for CainStr<'a>

fn from(src: &'a String) -> Self

Performs the conversion.

impl<'_> From<String> for CainStr<'_>

fn from(src: String) -> Self

Performs the conversion.

impl<'_> Hash for CainStr<'_>

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl<'a> Debug for CainStr<'a>

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

Formats the value using the given formatter.

impl<'_> Display for CainStr<'_>

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

Formats the value using the given formatter.

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cain_str: CainStr<'a>) -> Result<&'a str>

Performs the conversion.

impl<'a> TryFrom<CainStr<'a>> for String

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cain_str: CainStr<'a>) -> Result<String>

Performs the conversion.

impl<'_> FromStr for CainStr<'_>

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.