Enum Category 

#[non_exhaustive]
pub enum Category {
    Email,
    Name,
    Phone,
    CreditCard,
    Ssn,
    IpV4,
    IpV6,
    MacAddress,
    Hostname,
    ContainerId,
    Uuid,
    Jwt,
    AuthToken,
    FilePath,
    WindowsSid,
    Url,
    AwsArn,
    AzureResourceId,
    Custom(CompactString),
}

Classification of a sensitive data value. Determines the replacement format.

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.

Email

Email addresses → preserve domain, hex username

Name

Person names → synthetic name from hash-indexed table

Phone

Phone numbers → format-preserving numeric replacement

CreditCard

Credit card numbers → format-preserving numeric replacement (fails Luhn)

Ssn

Social Security Numbers → 000-<hash>-formatted replacement

IpV4

IPv4 addresses → preserve dots, replace digit groups

IpV6

IPv6 addresses → preserve colons/::, replace hex digits

MacAddress

MAC addresses → preserve : or - separators, replace hex digits

Hostname

Hostname / FQDN → preserve domain suffix, hex prefix

ContainerId

Docker / container hex IDs → replace hex digits

Uuid

UUIDs → preserve - dashes, replace hex digits

Jwt

JSON Web Tokens → preserve . separators, replace base64url chars

AuthToken

Opaque auth tokens / API keys / bearer tokens

FilePath

File paths → preserve /, \, and extension; replace segment content

WindowsSid

Windows Security Identifiers → preserve S- prefix and - separators

Url

URLs → preserve scheme and structural chars (://, /, ?, =, &)

AwsArn

AWS ARNs → preserve : and / separators, replace content segments

AzureResourceId

Azure Resource IDs → preserve / structure and well-known segment names

Custom(CompactString)

Arbitrary / user-defined category

Implementations

impl Category

pub fn as_str(&self) -> &str

Return the canonical string representation for this category.

pub fn domain_tag(&self) -> &str

Return a stable string key used for HMAC domain separation.

Equivalent to as_str() for backward compatibility. For HMAC domain separation use domain_tag_hmac() which prefixes custom categories to prevent collisions.

pub fn domain_tag_hmac(&self) -> String

Return a collision-safe string key for HMAC domain separation.

For Custom categories, this includes the custom: prefix to prevent collisions with built-in category tags (e.g. a Custom("email") won’t collide with the built-in Email tag).

Trait Implementations

impl Clone for Category

fn clone(&self) -> Category

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Category

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Category

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Category

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

Formats the value using the given formatter.

impl Hash for Category

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 PartialEq for Category

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

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for Category

impl StructuralPartialEq for Category