Struct sub_strs::Glob

pub struct Glob<'a> { /* private fields */ }

Glob

This struct is used to find matches from a pattern string against some string.

The pattern string supports 2 special characters: * and ?:

• *: matches any characters or nothing at all.
• ?: matches one single character.

Notes

• The idea is inspired by https://en.wikipedia.org/wiki/Glob_%28programming%29, but this is not an implementation of that or any other specifications.
• Matches are case sensitive. If you want to ignore case, consider using to_lowercase() (or to_uppercase()) on both pattern and target string.
• Display implementation prints parsed pattern, not the original one.
• Implementations of From<&'a str> and From<&'a String> always borrow the source string.
• Implementations of FromStr and From<String> will clone the source string.

Examples

use sub_strs::Glob;

let g = Glob::from("*r?st.rs");
for s in &["rust.rs", "rEst.rs", "it's rust.rs"] {
    assert!(g.matches(s));
}
for s in &["it's not Rust", "rest", "rust!.rs"] {
    assert!(g.matches(s) == false);
}

Implementations

impl<'a> Glob<'a>

pub fn matches<S>(&self, s: S) -> boolwhere
    S: AsRef<str>,

Checks if this glob matches a string

Trait Implementations

impl<'a> Debug for Glob<'a>

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

Formats the value using the given formatter.

impl Display for Glob<'_>

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

Formats the value using the given formatter.

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

Converts from a &String to Glob

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

Converts to this type from the input type.

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

Converts from a &str to Glob

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

Converts to this type from the input type.

impl<'a> From<Cow<'a, str>> for Glob<'a>

fn from(s: Cow<'a, str>) -> Self

Converts to this type from the input type.

impl From<String> for Glob<'_>

Converts from a String to Glob

fn from(src: String) -> Self

Converts to this type from the input type.

impl FromStr for Glob<'_>

type Err = 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<'a> Hash for Glob<'a>

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<'a> Ord for Glob<'a>

fn cmp(&self, other: &Glob<'a>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<'a> PartialEq<Glob<'a>> for Glob<'a>

fn eq(&self, other: &Glob<'a>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialOrd<Glob<'a>> for Glob<'a>

fn partial_cmp(&self, other: &Glob<'a>) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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<'a> Eq for Glob<'a>

impl<'a> StructuralEq for Glob<'a>

impl<'a> StructuralPartialEq for Glob<'a>