mask-text

Crates.iomask-text
lib.rsmask-text
version0.1.2
sourcesrc
created_at2022-11-01 20:28:52.843897
updated_at2022-11-01 22:43:10.209354
descriptionThis is a library to mask text with multiple masking options
homepagehttps://github.com/rusty-ferris-club/mask-text
repositoryhttps://github.com/rusty-ferris-club/mask-text
max_upload_size
id703041
size19,326
Elad Kaplan (kaplanelad)

documentation

https://docs.rs/mask-text/latest/mask-text

README

mask-text

Crates.io CI

This is a library to mask text with multiple masking options

Usage

[dependencies]
mask-text = { version = "0.1.2" }

Mask Options

  • Percentage
  • Regex
  • Prefix
  • All

Examples


fn main() {
    // masking 80% of the given text. minimum masking chars should bigger then 3.
    let percentage_result = mask_text::Kind::Percentage("text to mask".to_string(), 80, 3, "*".to_string()).mask();

    // masking text by regex group.
    let re = Regex::new("([a-z].*) (mask) ([a-z].*)").unwrap();
    let regex_result = mask_text::Kind::Regex("text to mask on group".to_string(), re, 2, "*".to_string()).mask();
    
    // masking 3 first chars from the string.
    let prefix_result = mask_text::Kind::Prefix("text to mask".to_string(), 3, "*".to_string()).mask();

    // masking all chars.
    let all_result = mask_text::Kind::All("text to mask".to_string(), "*".to_string()).mask()
}

All the examples here

Thanks

To all Contributors - you make this happen, thanks!

Copyright

Copyright (c) 2022 @kaplanelad. See LICENSE for further details.

Commit count: 10

cargo fmt