Struct PiiEntity 

pub struct PiiEntity {
    pub entity_type: EntityType,
    pub span: Span,
    pub text: String,
    pub confidence: Confidence,
    pub recognizer_id: String,
}

A detected PII entity within text.

Examples

use cloakrs_core::{Confidence, EntityType, PiiEntity, Span};

let entity = PiiEntity {
    entity_type: EntityType::Email,
    span: Span::new(11, 27),
    text: "user@example.com".to_string(),
    confidence: Confidence::new(0.95).unwrap(),
    recognizer_id: "email_regex_v1".to_string(),
};

assert_eq!(entity.span.len(), 16);

Fields

entity_type: EntityType

The type of PII detected.

span: Span

Byte offset range in the source text, using [start, end).

text: String

The matched value.

confidence: Confidence

Confidence score from 0.0 to 1.0.

recognizer_id: String

Identifier of the recognizer that produced this finding.

Trait Implementations

impl Clone for PiiEntity

fn clone(&self) -> PiiEntity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PiiEntity

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PiiEntity

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PiiEntity

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PiiEntity