Struct ReplacementConfig 

#[non_exhaustive]
pub struct ReplacementConfig {
    pub key_replacements: SmallVec<[(String, String); 2]>,
    pub value_replacements: SmallVec<[(String, String); 2]>,
    pub key_exclusions: SmallVec<[String; 2]>,
    pub value_exclusions: SmallVec<[String; 2]>,
}

Configuration for replacement operations

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key_replacements: SmallVec<[(String, String); 2]>

Key replacement patterns (find, replace) Uses SmallVec to avoid heap allocation for 0-2 replacements (common case)

value_replacements: SmallVec<[(String, String); 2]>

Value replacement patterns (find, replace) Uses SmallVec to avoid heap allocation for 0-2 replacements (common case)

key_exclusions: SmallVec<[String; 2]>

Patterns for excluding entire keys (and their values/subtrees) by name. Literal substring match by default; wrap in r'...' for regex, matching key_replacements’s convention. A key matches if any pattern is found in its full dot-path (flatten/unflatten) or in its own name at that nesting level (normal mode) – matching a container key drops its entire subtree without walking it. See crate::builder::JSONTools::exclude_key for full docs.

value_exclusions: SmallVec<[String; 2]>

Patterns for dropping a key-value pair by value content. Literal substring match by default; wrap in r'...' for regex. Only ever applies to scalar leaf values (strings/numbers/booleans/null) – containers have no single value to check. Checked against the final value after any configured value_replacement/auto_convert_types have run, matching remove_nulls’s ordering guarantee. A no-op at the document root (no parent key to drop the value from), same precedent as remove_nulls. See crate::builder::JSONTools::exclude_value for full docs including the unflatten quoted-form caveat.

Implementations

impl ReplacementConfig

pub fn new() -> Self

Create a new ReplacementConfig with no replacements

pub fn add_key_replacement( self, find: impl Into<String>, replace: impl Into<String>, ) -> Self

Add a key replacement pattern

pub fn add_value_replacement( self, find: impl Into<String>, replace: impl Into<String>, ) -> Self

Add a value replacement pattern

pub fn has_key_replacements(&self) -> bool

Check if any key replacements are configured

pub fn has_value_replacements(&self) -> bool

Check if any value replacements are configured

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

Add a key exclusion pattern

pub fn has_key_exclusions(&self) -> bool

Check if any key exclusions are configured

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

Add a value exclusion pattern

pub fn has_value_exclusions(&self) -> bool

Check if any value exclusions are configured

Trait Implementations

impl Clone for ReplacementConfig

fn clone(&self) -> ReplacementConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReplacementConfig

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

Formats the value using the given formatter.

impl Default for ReplacementConfig

fn default() -> ReplacementConfig

Returns the “default value” for a type.