Enum SecretKind 

#[non_exhaustive]
pub enum SecretKind {
    AwsAccessKeyId,
    GithubToken,
    GitlabToken,
    SlackToken,
    PrivateKey,
    Jwt,
    HighEntropy,
    Custom(String),
}

The kind of secret a detector found. Display yields the stable slug used inside the replacement token and in hh scan output.

#[non_exhaustive]: new named detectors are the roadmap (more token types over time); this keeps that additive under semver-checks. Variant construction from other crates is unaffected — only exhaustive match requires a wildcard arm, which nothing outside this crate currently does.

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.

AwsAccessKeyId

AWS access key id (AKIA…/ASIA… and friends).

GithubToken

GitHub token (ghp_/gho_/ghu_/ghs_/ghr_/github_pat_).

GitlabToken

GitLab token (glpat-/glrt-/gldt-/glsoat-/glcbt-).

SlackToken

Slack token (xoxb-/xoxa-/xoxp-/xoxr-/xoxs-/xoxe-).

PrivateKey

A PEM private-key block (-----BEGIN … PRIVATE KEY-----).

Jwt

A JSON Web Token (three base64url segments, eyJ…-headed).

HighEntropy

A generic high-entropy string above the conservative threshold.

Custom(String)

A user-defined rule from config [redaction] rules; reports as custom:<name>.

Trait Implementations

impl Clone for SecretKind

fn clone(&self) -> SecretKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretKind

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

Formats the value using the given formatter.

impl Display for SecretKind

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

Formats the value using the given formatter.

impl Eq for SecretKind

impl Hash for SecretKind

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 SecretKind

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SecretKind

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