Struct Redactions 

pub struct Redactions {
    vars: Option<BTreeMap<RedactedValueInner, BTreeSet<&'static str>>>,
    unused: Option<BTreeSet<RedactedValueInner>>,
}

Replace data with placeholders

This can be used for:

• Handling test-run dependent data like temp directories or elapsed time
• Making special characters more obvious (e.g. redacting a tab a [TAB])
• Normalizing platform-specific data like std::env::consts::EXE_SUFFIX

Examples

let mut subst = snapbox::Redactions::new();
subst.insert("[LOCATION]", "World");
assert_eq!(subst.redact("Hello World!"), "Hello [LOCATION]!");

Fields

vars: Option<BTreeMap<RedactedValueInner, BTreeSet<&'static str>>>

unused: Option<BTreeSet<RedactedValueInner>>

Implementations

impl Redactions

pub const fn new() -> Redactions

pub fn insert( &mut self, placeholder: &'static str, value: impl Into<RedactedValue>, ) -> Result<(), Error>

Insert an additional match pattern

placeholder must be enclosed in [ and ].

let mut subst = snapbox::Redactions::new();
subst.insert("[EXE]", std::env::consts::EXE_SUFFIX);

With the regex feature, you can define patterns using regexes. You can choose to replace a subset of the regex by giving it the named capture group redacted.

let mut subst = snapbox::Redactions::new();
subst.insert("[OBJECT]", regex::Regex::new("(?<redacted>(world|moon))").unwrap());
assert_eq!(subst.redact("Hello world!"), "Hello [OBJECT]!");
assert_eq!(subst.redact("Hello moon!"), "Hello [OBJECT]!");
assert_eq!(subst.redact("Hello other!"), "Hello other!");

pub fn extend( &mut self, vars: impl IntoIterator<Item = (&'static str, impl Into<RedactedValue>)>, ) -> Result<(), Error>

Insert additional match patterns

Placeholders must be enclosed in [ and ].

pub fn remove(&mut self, placeholder: &'static str) -> Result<(), Error>

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

Apply redaction only, no pattern-dependent globs

Examples

let mut subst = snapbox::Redactions::new();
subst.insert("[LOCATION]", "World");
let output = subst.redact("Hello World!");
assert_eq!(output, "Hello [LOCATION]!");

pub fn clear_unused<'v>(&self, pattern: &'v str) -> Cow<'v, str>

Clear unused redactions from expected data

Some redactions can be conditionally present, like redacting std::env::consts::EXE_SUFFIX. When the redaction is not present, it needs to be removed from the expected data so it can be matched against the actual data.

Trait Implementations

impl Clone for Redactions

fn clone(&self) -> Redactions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Redactions

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

Formats the value using the given formatter.

impl Default for Redactions

fn default() -> Redactions

Returns the “default value” for a type.

impl PartialEq for Redactions

fn eq(&self, other: &Redactions) -> 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 Eq for Redactions

impl StructuralPartialEq for Redactions

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 64 bytes