maskify 0.1.0

Zero-dependency, blazing-fast Rust crate for masking sensitive data — emails, phones, cards, Aadhaar, PAN, IPs & more. Comes with trait extensions and a builder pattern.
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

use crate::maskers;

/// A builder for creating reusable custom masking strategies.
///
/// # Examples
/// ```
/// use maskify::Masker;
///
/// let masker = Masker::new()
///     .keep_start(4)
///     .keep_end(4)
///     .mask_char('#');
///
/// assert_eq!(masker.apply("1234567890123456"), "1234########3456");
/// assert_eq!(masker.apply("ABCDEFGHIJKLMNOP"), "ABCD########MNOP");
/// ```
#[derive(Debug, Clone)]
pub struct Masker {
    start: usize,
    end: usize,
    ch: char,
}

impl Masker {
    /// Create a new Masker with default settings (mask everything with `*`).
    pub fn new() -> Self {
        Masker {
            start: 0,
            end: 0,
            ch: '*',
        }
    }

    /// Set how many characters to keep visible at the start.
    pub fn keep_start(mut self, n: usize) -> Self {
        self.start = n;
        self
    }

    /// Set how many characters to keep visible at the end.
    pub fn keep_end(mut self, n: usize) -> Self {
        self.end = n;
        self
    }

    /// Set the masking character (default: `*`).
    pub fn mask_char(mut self, c: char) -> Self {
        self.ch = c;
        self
    }

    /// Apply the masking strategy to a string.
    #[must_use]
    pub fn apply(&self, input: &str) -> String {
        maskers::mask_custom(input, self.start, self.end, self.ch)
    }
}

impl Default for Masker {
    fn default() -> Self {
        Self::new()
    }
}