Enum PiiClass 

pub enum PiiClass {
    Email,
    Name,
    Location,
    Organization,
    Custom(String),
}

The category of a detected PII span.

Built-in variants: Email, Name, Location, Organization. Tenant-specific PII (case references, titles, internal codes) is carried as PiiClass::Custom(String). There is no Phone variant – phone detection is provided by recognizers in gaze-recognizers and surfaces as either a Custom("phone") class or a class defined by a rulepack.

PiiClass is exhaustive. Match every variant explicitly so new built-in classes force call sites to review their handling at compile time:

use gaze_types::PiiClass;

fn label(class: &PiiClass) -> &'static str {
    match class {
        PiiClass::Email        => "email",
        PiiClass::Name         => "name",
        PiiClass::Location     => "location",
        PiiClass::Organization => "org",
        PiiClass::Custom(_)    => "pii",
    }
}

Policy TOML uses the lowercase forms email / name / location / organization, and tenant classes are spelled like custom:case_ref (lowercase, snake_case).

Variants

Email

Email address class.

Name

Person name class.

Location

Location class.

Organization

Organization class.

Custom(String)

Tenant- or policy-defined class.

Implementations

impl PiiClass

pub fn from_policy_name(input: &str) -> Option<Self>

Parses a policy class name into the shared class vocabulary.

pub fn builtin_variants() -> &'static [PiiClass]

Returns the built-in class variants.

pub fn custom(name: &str) -> Self

Builds a normalized custom class name.

pub fn as_custom_name(&self) -> Option<&str>

Returns the normalized custom class name for custom classes.

pub fn class_name(&self) -> String

Returns the audit/token display label for this class.

pub fn to_canonical_str(&self) -> String

Returns the canonical audit/serde label for this class.

pub fn from_canonical_str(value: &str) -> Option<Self>

Parses the canonical audit/serde label for a PII class.

Trait Implementations

impl Clone for PiiClass

fn clone(&self) -> PiiClass

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PiiClass

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PiiClass

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for PiiClass

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PiiClass

fn cmp(&self, other: &PiiClass) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PiiClass

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

fn partial_cmp(&self, other: &PiiClass) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for PiiClass

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 PiiClass

impl StructuralPartialEq for PiiClass