Struct FieldRule 

pub struct FieldRule {
    pub pattern: String,
    pub category: Option<Category>,
    pub label: Option<String>,
    pub min_length: Option<usize>,
    pub sub_processor: Option<String>,
    pub sub_fields: Vec<FieldRule>,
}

A rule describing a single field/key to sanitize.

Pattern Syntax

• Exact key: "password", "db_host".
• Dotted path: "database.password", "smtp.user".
• Glob suffix: "*.password" — matches any key ending in .password.
• Glob prefix: "db.*" — matches any key starting with db..
• Wildcard: "*" — matches every field.

Sub-processor

When a field’s value is itself a structured document (e.g. YAML embedded in a Ruby heredoc), set sub_processor to the processor name and provide sub_fields with rules for the nested content. The parent processor extracts the value and delegates it to the named sub-processor.

- pattern: "*['ldap_servers']"
  sub_processor: yaml
  sub_fields:
    - pattern: "*.password"
      category: custom:password
    - pattern: "*.bind_dn"
      category: custom:dn

Fields

pattern: String

Key pattern to match (see Pattern Syntax above).

category: Option<Category>

Category for replacement generation. Defaults to Custom("field") if not specified. Ignored when sub_processor is set.

label: Option<String>

Optional human-readable label for reporting.

min_length: Option<usize>

Minimum byte length a value must reach before it is replaced.

Values shorter than this threshold pass through unchanged. Use this to avoid redacting obviously non-secret values matched by broad glob patterns (e.g. "false", "0", "nil" matched by *secret*).

A value of 8 is a reasonable default for token/password fields. Omit (or set to 0) to replace all matching values regardless of length.

sub_processor: Option<String>

Name of the processor to use for the field’s value when it contains an embedded structured document (e.g. "yaml", "json", "toml").

sub_fields: Vec<FieldRule>

Field rules applied by sub_processor to the nested content. Ignored when sub_processor is None.

Implementations

impl FieldRule

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

Create a new field rule with just a pattern.

pub fn with_min_length(self, min: usize) -> Self

Set the minimum value length required for replacement.

pub fn with_category(self, category: Category) -> Self

Set the category for this rule.

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

Set the label for this rule.

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

Set the sub-processor name for embedded structured content.

pub fn with_sub_fields(self, fields: Vec<FieldRule>) -> Self

Set the field rules applied by the sub-processor.

Trait Implementations

impl Clone for FieldRule

fn clone(&self) -> FieldRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldRule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FieldRule

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FieldRule

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.