Enum PiiEntityType 

#[non_exhaustive]
pub enum PiiEntityType {
    Address,
    Age,
    All,
    AwsAccessKey,
    AwsSecretKey,
    CaHealthNumber,
    CaSocialInsuranceNumber,
    CreditDebitCardCvv,
    CreditDebitCardExpiry,
    CreditDebitCardNumber,
    DriverId,
    Email,
    InternationalBankAccountNumber,
    IpAddress,
    LicensePlate,
    MacAddress,
    Name,
    Password,
    Phone,
    Pin,
    SwiftCode,
    UkNationalHealthServiceNumber,
    UkNationalInsuranceNumber,
    UkUniqueTaxpayerReferenceNumber,
    Url,
    Username,
    UsBankAccountNumber,
    UsBankRoutingNumber,
    UsIndividualTaxIdentificationNumber,
    UsPassportNumber,
    UsSocialSecurityNumber,
    VehicleIdentificationNumber,
    Unknown(UnknownVariantValue),
}

When writing a match expression against PiiEntityType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Here is an example of how you can make a match expression forward-compatible:

# let piientitytype = unimplemented!();
match piientitytype {
    PiiEntityType::Address => { /* ... */ },
    PiiEntityType::Age => { /* ... */ },
    PiiEntityType::All => { /* ... */ },
    PiiEntityType::AwsAccessKey => { /* ... */ },
    PiiEntityType::AwsSecretKey => { /* ... */ },
    PiiEntityType::CaHealthNumber => { /* ... */ },
    PiiEntityType::CaSocialInsuranceNumber => { /* ... */ },
    PiiEntityType::CreditDebitCardCvv => { /* ... */ },
    PiiEntityType::CreditDebitCardExpiry => { /* ... */ },
    PiiEntityType::CreditDebitCardNumber => { /* ... */ },
    PiiEntityType::DriverId => { /* ... */ },
    PiiEntityType::Email => { /* ... */ },
    PiiEntityType::InternationalBankAccountNumber => { /* ... */ },
    PiiEntityType::IpAddress => { /* ... */ },
    PiiEntityType::LicensePlate => { /* ... */ },
    PiiEntityType::MacAddress => { /* ... */ },
    PiiEntityType::Name => { /* ... */ },
    PiiEntityType::Password => { /* ... */ },
    PiiEntityType::Phone => { /* ... */ },
    PiiEntityType::Pin => { /* ... */ },
    PiiEntityType::SwiftCode => { /* ... */ },
    PiiEntityType::UkNationalHealthServiceNumber => { /* ... */ },
    PiiEntityType::UkNationalInsuranceNumber => { /* ... */ },
    PiiEntityType::UkUniqueTaxpayerReferenceNumber => { /* ... */ },
    PiiEntityType::Url => { /* ... */ },
    PiiEntityType::Username => { /* ... */ },
    PiiEntityType::UsBankAccountNumber => { /* ... */ },
    PiiEntityType::UsBankRoutingNumber => { /* ... */ },
    PiiEntityType::UsIndividualTaxIdentificationNumber => { /* ... */ },
    PiiEntityType::UsPassportNumber => { /* ... */ },
    PiiEntityType::UsSocialSecurityNumber => { /* ... */ },
    PiiEntityType::VehicleIdentificationNumber => { /* ... */ },
    other @ _ if other.as_str() == "NewFeature" => { /* handles a case for `NewFeature` */ },
    _ => { /* ... */ },
}

The above code demonstrates that when piientitytype represents NewFeature, the execution path will lead to the second last match arm, even though the enum does not contain a variant PiiEntityType::NewFeature in the current version of SDK. The reason is that the variable other, created by the @ operator, is bound to PiiEntityType::Unknown(UnknownVariantValue("NewFeature".to_owned())) and calling as_str on it yields "NewFeature". This match expression is forward-compatible when executed with a newer version of SDK where the variant PiiEntityType::NewFeature is defined. Specifically, when piientitytype represents NewFeature, the execution path will hit the second last match arm as before by virtue of calling as_str on PiiEntityType::NewFeature also yielding "NewFeature".

Explicitly matching on the Unknown variant should be avoided for two reasons:

• The inner data UnknownVariantValue is opaque, and no further information can be extracted.
• It might inadvertently shadow other intended match arms.

Types of PII entities that can be detected, we will support every types that Guardrails can support

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Address

A physical address, such as ‘100 Main Street, Anytown, USA’ or ‘Suite #12, Building 123’

Age

An individual’s age, including the quantity and unit of time

All

All supported PII entity types

AwsAccessKey

A unique identifier associated with AWS secret access key

AwsSecretKey

A unique identifier associated with AWS access key for signing programmatic requests

CaHealthNumber

A Canadian Health Service Number - 10-digit unique identifier for healthcare benefits

CaSocialInsuranceNumber

A Canadian Social Insurance Number (SIN) - nine-digit unique identifier

CreditDebitCardCvv

A three-digit card verification code (CVV) for VISA, MasterCard, and Discover cards, or four-digit for American Express

CreditDebitCardExpiry

The expiration date for a credit or debit card

CreditDebitCardNumber

The number for a credit or debit card

DriverId

The number assigned to a driver’s license

Email

An email address, such as marymajor@email.com

InternationalBankAccountNumber

An International Bank Account Number with specific formats for each country

IpAddress

An IPv4 address, such as 198.51.100.0

LicensePlate

A license plate for a vehicle issued by the state or country where the vehicle is registered

MacAddress

A media access control (MAC) address - unique identifier for network interface controller

Name

An individual’s name. Does not include titles such as Dr., Mr., Mrs., or Miss

Password

An alphanumeric string that is used as a password

Phone

A phone number. Also includes fax and pager numbers

Pin

A four-digit personal identification number (PIN)

SwiftCode

A SWIFT code - standard format of Bank Identifier Code (BIC)

UkNationalHealthServiceNumber

A UK National Health Service Number - 10-17 digit number

UkNationalInsuranceNumber

A UK National Insurance Number (NINO) for accessing National Insurance benefits

UkUniqueTaxpayerReferenceNumber

A UK Unique Taxpayer Reference (UTR) - 10-digit number identifying taxpayer or business

Url

A web address, such as www.example.com

Username

A user name that identifies an account, such as a login name, screen name, nick name, or handle

UsBankAccountNumber

A US bank account number, typically 10 to 12 digits long

UsBankRoutingNumber

A US bank account routing number, typically nine digits long

UsIndividualTaxIdentificationNumber

A US Individual Taxpayer Identification Number (ITIN)

UsPassportNumber

A US passport number, ranging from six to nine alphanumeric characters

UsSocialSecurityNumber

A US Social Security Number (SSN) - nine-digit number for US citizens and residents

VehicleIdentificationNumber

A Vehicle Identification Number (VIN) that uniquely identifies a vehicle

Unknown(UnknownVariantValue)

👎Deprecated: Don’t directly match on Unknown. See the docs on this enum for the correct way to handle unknown variants.

Unknown contains new variants that have been added since this code was generated.

Implementations

impl PiiEntityType

pub fn as_str(&self) -> &str

Returns the &str value of the enum member.

pub const fn values() -> &'static [&'static str]

Returns all the &str representations of the enum members.

impl PiiEntityType

pub fn try_parse(value: &str) -> Result<Self, UnknownVariantError>

Parses the enum value while disallowing unknown variants.

Unknown variants will result in an error.

Trait Implementations

impl AsRef<str> for PiiEntityType

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for PiiEntityType

fn clone(&self) -> PiiEntityType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PiiEntityType

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

Formats the value using the given formatter.

impl Display for PiiEntityType

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

Formats the value using the given formatter.

impl From<&str> for PiiEntityType

fn from(s: &str) -> Self

Converts to this type from the input type.

impl FromStr for PiiEntityType

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for PiiEntityType

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 PiiEntityType

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

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

fn partial_cmp(&self, other: &PiiEntityType) -> 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 Eq for PiiEntityType

impl StructuralPartialEq for PiiEntityType