Struct redact_engine::Redaction

pub struct Redaction { /* private fields */ }

Define redact settings

Implementations

impl Redaction

pub fn new() -> Self

Create a Redaction Methods

Example

use redact_engine::Redaction;
Redaction::custom("CUSTOM_HIDDEN_TEXT")

pub fn custom(redact_placeholder: &str) -> Self

Create a Redaction with redact placeholder text.

Arguments

• redact_placeholder - placeholder redaction

Example

use redact_engine::Redaction;
Redaction::custom("[HIDDEN_VALUE]")

pub fn add_value(self, value: &str) -> Result<Self>

redact exact string match

Arguments

• value - The redaction value

Example

use redact_engine::Redaction;
let text = "foo,bar";
Redaction::new().add_value("foo");

Errors

when the value could not converted to a regex

pub fn add_values(self, values: Vec<&str>) -> Result<Self>

redact exact string match from list of strings

Arguments

• values - List of redaction value

Example

use redact_engine::Redaction;
let text = "foo,bar,baz";
Redaction::new().add_values(vec!["foo", "baz"]);

Errors

when the value could not converted to a regex

pub fn add_pattern(self, pattern: Pattern) -> Self

Add a Pattern to the redaction list

Arguments

• pattern - redact Pattern

Example

use redact_engine::{Redaction, Pattern};
use regex::Regex;
let text = "foo,bar";
let pattern = Pattern {
   test: Regex::new("(bar)").unwrap(),
   group: 1,
};

Redaction::new().add_pattern(pattern);

pub fn add_patterns(self, patterns: Vec<Pattern>) -> Self

Add list if Pattern to the redaction list

Arguments

• patterns - List of redact Pattern

Example

use redact_engine::{Redaction, Pattern};
use regex::Regex;
let text = "foo,bar";
let pattern = Pattern {
   test: Regex::new("(bar)").unwrap(),
   group: 1,
};

Redaction::new().add_patterns(vec![pattern]);

pub fn redact_str(&self, str: &str) -> String

Redact from string

pub fn redact_reader<R>(&self, rdr: R) -> Result<String>where
    R: Read,

Redact text from reader

Errors

• When file not exists.
• Could not open reader.

Trait Implementations

impl Default for Redaction

fn default() -> Self

Create a Redaction Methods

Example

use redact_engine::Redaction;
Redaction::default()