twistrs 1.1.4

A domain name permutation library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

use crate::permutate::DomainRef;
use crate::Domain;

/// The `Filter` trait provides functions that allow filtering of permutations given a certain
/// condition. This is useful when certain permutation methods (e.g.,
/// [`tld`](./permutate/Domain#tld)) expose permutations that you would like to dismiss.
pub trait Filter {
    type Error;

    fn matches(&self, domain: &Domain) -> bool;

    /// **Note** — this is currently not being used internally.
    fn try_matches(&self, domain: &Domain) -> Result<bool, Self::Error> {
        Ok(Self::matches(self, domain))
    }
}

/// An allocation-free filter that operates on [`DomainRef`].
#[allow(clippy::module_name_repetitions)]
pub trait FilterRef {
    type Error;

    fn matches(&self, domain: DomainRef<'_>) -> bool;

    /// **Note** &mdash; this is currently not being used internally.
    fn try_matches(&self, domain: DomainRef<'_>) -> Result<bool, Self::Error> {
        Ok(Self::matches(self, domain))
    }
}

/// Open filter, all results are retained; similar to a wildcard.
#[derive(Default, Copy, Clone)]
pub struct Permissive;

impl Filter for Permissive {
    type Error = ();

    fn matches(&self, _: &Domain) -> bool {
        true
    }
}

impl FilterRef for Permissive {
    type Error = ();

    fn matches(&self, _: DomainRef<'_>) -> bool {
        true
    }
}

/// When passed a slice of string patterns, will filter out values that do **not** contain any of
/// the substrings.
///
/// Example usage may be filtering the [`tld`](./permutate/Domain#tld) permutations to only include
/// TLDs that contain part of the origin TLD.
#[derive(Default, Copy, Clone)]
pub struct Substring<'a, S: AsRef<str> + 'a> {
    substrings: &'a [S],
}

impl<'a, S: AsRef<str>> Substring<'a, S> {
    pub fn new(substrings: &'a [S]) -> Self {
        Self { substrings }
    }
}

impl<S: AsRef<str>> Filter for Substring<'_, S> {
    type Error = ();

    fn matches(&self, domain: &Domain) -> bool {
        self.substrings
            .iter()
            .any(|s| domain.fqdn.contains(s.as_ref()))
    }
}

impl<S: AsRef<str>> FilterRef for Substring<'_, S> {
    type Error = ();

    fn matches(&self, domain: DomainRef<'_>) -> bool {
        self.substrings
            .iter()
            .any(|s| domain.fqdn.contains(s.as_ref()))
    }
}