Struct Candidate 

#[non_exhaustive]
pub struct Candidate {
    pub span: Range<usize>,
    pub class: PiiClass,
    pub recognizer_id: String,
    pub score: f32,
    pub priority: i32,
    pub canonical_form: Option<String>,
    pub token_family: String,
    pub source: String,
    pub decided_by: ConflictTier,
    pub merged_sources: Vec<String>,
}

Candidate PII span emitted by a recognizer before final conflict resolution.

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.

span: Range<usize>

Byte span in the original input.

class: PiiClass

PII class assigned to the span.

recognizer_id: String

Recognizer identifier.

score: f32

Recognizer confidence score.

priority: i32

Rule or recognizer priority.

canonical_form: Option<String>

Optional canonical representation for validation/merge logic.

token_family: String

Token family used for output token shape.

source: String

Candidate source label.

decided_by: ConflictTier

Conflict tier that decided this candidate.

merged_sources: Vec<String>

Sources merged into this candidate.

Implementations

impl Candidate

pub fn new( span: Range<usize>, class: PiiClass, recognizer_id: impl Into<String>, score: f32, priority: i32, canonical_form: Option<String>, token_family: impl Into<String>, source: impl Into<String>, decided_by: ConflictTier, merged_sources: Vec<String>, ) -> Self

Builds a recognizer candidate.

pub fn with_span(self, span: Range<usize>) -> Self

Returns this candidate with a translated span.

Trait Implementations

impl Clone for Candidate

fn clone(&self) -> Candidate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Candidate

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

Formats the value using the given formatter.

impl PartialEq for Candidate

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