Struct Redaction 

pub struct Redaction { /* private fields */ }

Mask string and number leaves whose key matches a pattern.

A leaf’s key is the last key on its path, so the items of a tokens list are masked too. Everything under a matching key is masked, so {"password": {"value": "…"}} and an XML <password type="…">…</password> (whose text sits under #text) are covered. Patterns match case-insensitively, with - and _ interchangeable (api-key matches api_key): as a substring, or as a whole-key glob when they contain * or ?. Masked leaves become the mask string and keep their metadata; booleans and nulls are left alone, and so is the structure.

use rich_ext::data::{parse, Format, Redaction, Value};

let node = parse(Format::Json, r#"{"db": {"user": "u", "Password": "hunter2"}}"#).unwrap();
let safe = node.redacted(&Redaction::secrets());
assert_eq!(safe.get("db").unwrap().get("Password").unwrap().value, Value::String("********".into()));
assert_eq!(safe.get("db").unwrap().get("user").unwrap().value, Value::String("u".into()));

Implementations

impl Redaction

pub fn new() -> Self

No patterns, mask ********.

pub fn secrets() -> Self

Common secret key names (see SECRET_KEYS).

pub fn pattern(self, pattern: impl Into<String>) -> Self

Add a key pattern.

pub fn patterns<S: Into<String>>( self, patterns: impl IntoIterator<Item = S>, ) -> Self

Add key patterns.

pub fn mask(self, mask: impl Into<String>) -> Self

The replacement text.

pub fn matches_key(&self, key: &str) -> bool

Whether key matches a pattern. - and _ are interchangeable.

Trait Implementations

impl Clone for Redaction

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Redaction

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

Formats the value using the given formatter.

impl Default for Redaction

fn default() -> Self

Returns the “default value” for a type.

impl Redactor for Redaction

fn redact(&self, path: &Path, node: &Node) -> Option<Node>

The node to show instead of node, or None to keep it.