Enum PiiKind 

pub enum PiiKind {
    Email,
    CreditCard,
    Iban,
    NationalId,
    IpAddress,
    UrlCredentials,
    Phone,
    Person,
    Organization,
    Location,
    Address,
    Custom,
}

The kinds of personal data a detector can report. The order is the precedence when two detectors’ spans overlap at equal length — the check-digit formats (card, IBAN, national ID) over a phone number, whose digit groups they also look like.

Variants

Email

CreditCard

Iban

NationalId

IpAddress

UrlCredentials

Phone

Person

Organization

Location

Address

Custom

A caller-supplied pattern (CustomPattern) or deny term.

Implementations

impl PiiKind

pub const ALL: [PiiKind; 12]

Every kind, in precedence order.

pub const PATTERN: [PiiKind; 7]

The kinds the pattern detector handles itself (no model needed).

pub const NER: [PiiKind; 4]

The kinds only a named-entity model finds.

pub const ACCEPTED: &'static str = "email, phone, credit_card, iban, ip_address, \ url_credentials, national_id, person, organization, location, address, custom"

Every spelling parse accepts, for error messages.

pub fn label(self) -> &'static str

The placeholder label: [EMAIL], [PERSON_2].

pub fn name(self) -> &'static str

The wire / CLI spelling (credit_card, ip_address, …).

pub fn parse(s: &str) -> Option<Self>

Parse a wire spelling (case-insensitive; - as _; ip and org accepted as shorthands).

Trait Implementations

impl Clone for PiiKind

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PiiKind

impl Debug for PiiKind

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

Formats the value using the given formatter.

impl Eq for PiiKind

impl Hash for PiiKind

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 PiiKind

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for PiiKind

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for PiiKind

fn partial_cmp(&self, other: &Self) -> 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 StructuralPartialEq for PiiKind