Struct RedactionEntry 

#[non_exhaustive]
pub struct RedactionEntry {

    pub source: String,
    pub recognizer_id: Option<String>,
    pub recognizer_version_id: Option<String>,
    pub class: PiiClass,
    pub action: Action,
    pub field_name: Option<String>,
    pub document_kind: DocumentKind,
    pub conflict_loser: bool,
    pub decided_by: ConflictTier,
    pub created_at: i64,
    pub session_id: Option<String>,
    pub validator_fail_reason: Option<ValidatorFailReason>,
    pub ambiguity_record: Option<AmbiguityRecord>,
    pub collision_family: Option<String>,
    pub collision_variant: Option<String>,
    pub fallback_triggered: Option<FallbackReason>,
}

One row of redaction metadata emitted to a RedactionLogger.

Fields identify the PII class, action taken, session ID, source document kind, conflict-resolution metadata, and timestamp. Does not contain the original PII value, the token string, or any identifiable content beyond what a compliance audit requires.

RedactionEntry is #[non_exhaustive]; adopters must construct via the public constructor or destructure with a wildcard pattern.

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.

source: String

Detector or recognizer source identifier.

recognizer_id: Option<String>

Stable semantic recognizer identifier, when available.

recognizer_version_id: Option<String>

Versioned recognizer artifact/rule identifier, when available.

class: PiiClass

PII class affected by the decision.

action: Action

Policy action applied to the span.

field_name: Option<String>

Optional structured field name.

document_kind: DocumentKind

Source document kind.

conflict_loser: bool

Whether this entry records a loser in conflict resolution.

decided_by: ConflictTier

Conflict tier that decided the outcome.

created_at: i64

Creation timestamp in epoch milliseconds.

session_id: Option<String>

Optional session identifier.

validator_fail_reason: Option<ValidatorFailReason>

Optional validator failure reason for a vetoed candidate.

ambiguity_record: Option<AmbiguityRecord>

Optional ambiguity metadata for a family-level fallback.

collision_family: Option<String>

Collision family that influenced this decision.

collision_variant: Option<String>

Collision variant that influenced this decision.

fallback_triggered: Option<FallbackReason>

Safety-net fallback reason, when fallback policy handled the row.

Implementations

impl RedactionEntry

pub fn new( source: impl Into<String>, class: PiiClass, action: Action, field_name: Option<String>, document_kind: DocumentKind, conflict_loser: bool, decided_by: ConflictTier, created_at: i64, session_id: Option<String>, ) -> Self

Builds a metadata-only redaction log entry.

pub fn with_validator_fail_reason(self, reason: ValidatorFailReason) -> Self

Attaches a validator failure reason to this metadata row.

pub fn with_ambiguity_record(self, record: AmbiguityRecord) -> Self

Attaches an ambiguity record to this metadata row.

pub fn with_collision_metadata( self, family: Option<String>, variant: Option<String>, ) -> Self

Attaches collision-family metadata to this row.

pub fn with_fallback_triggered(self, reason: FallbackReason) -> Self

Attaches safety-net fallback metadata to this row.

pub fn with_recognizer_metadata( self, recognizer_id: Option<String>, recognizer_version_id: Option<String>, ) -> Self

Attaches recognizer lineage metadata to this row.

Trait Implementations

impl Clone for RedactionEntry

fn clone(&self) -> RedactionEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RedactionEntry

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

Formats the value using the given formatter.

impl PartialEq for RedactionEntry

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for RedactionEntry

impl StructuralPartialEq for RedactionEntry