Struct IncludeSet 

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

Regex patterns used to include only matching words.

Examples

use word_tally::IncludeSet;

// Create a pattern to include only words containing vowels.
let patterns = IncludeSet::new(vec![r"[aeiou]".to_string()]).unwrap();

// Test matching
assert!(patterns.matches("test")); // Contains 'e'
assert!(!patterns.matches("rhythm")); // No vowels

Implementations

impl IncludeSet

pub fn new(input_patterns: PatternList) -> Result<Self, WordTallyError>

Creates patterns from owned pattern strings.

Examples

use word_tally::IncludeSet;

// Create patterns for including words with specific prefixes.
let patterns = IncludeSet::new(vec![r"^pre".to_string(), r"^un".to_string()]).unwrap();

assert_eq!(patterns.len(), 2);
assert!(patterns.matches("prevent"));
assert!(patterns.matches("unlike"));
assert!(!patterns.matches("likely"));

Errors

Returns an error if any pattern cannot be compiled into a valid regular expression.

pub fn matches(&self, word: &str) -> bool

Tests if a word matches any pattern.

pub fn as_patterns(&self) -> &[String]

Returns a slice of the original pattern strings.

pub const fn len(&self) -> usize

Returns the number of patterns.

pub const fn is_empty(&self) -> bool

Returns true if there are no patterns.

Trait Implementations

impl AsRef<[String]> for IncludeSet

fn as_ref(&self) -> &[String]

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

impl Clone for IncludeSet

fn clone(&self) -> IncludeSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IncludeSet

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

Formats the value using the given formatter.

impl Default for IncludeSet

fn default() -> IncludeSet

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IncludeSet

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for IncludeSet

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

Formats the value using the given formatter.

impl Hash for IncludeSet

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 Ord for IncludeSet

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 for IncludeSet

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

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 IncludeSet

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a [String]> for IncludeSet

type Error = Error

The type returned in the event of a conversion error.

fn try_from(input_patterns: &'a [String]) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for IncludeSet