Skip to main content

TriggerSource

Enum TriggerSource 

Source
#[non_exhaustive]
pub enum TriggerSource { Reveal, WithValue, Registry, Serialize, Custom(&'static str), }
Expand description

The source that triggered access to a canary token.

TriggerSource describes which instrumented API path observed access to a canary value. It is metadata only and must never contain the canary value itself.

§Built-in sources

use canarytrap::TriggerSource;

assert_eq!(TriggerSource::Reveal.to_string(), "reveal");
assert_eq!(TriggerSource::WithValue.to_string(), "with-value");
assert_eq!(TriggerSource::Registry.to_string(), "registry");
assert_eq!(TriggerSource::Serialize.to_string(), "serialize");

§Custom sources

Custom sources borrow a 'static string and are serialized with a custom: prefix:

use canarytrap::TriggerSource;

let source = TriggerSource::custom("serde");
assert_eq!(source.to_string(), "custom:serde");

§Parsing

Because TriggerSource::Custom stores a 'static string, parsing is provided for static input through TriggerSource::from_static and TryFrom<&'static str>. This avoids leaking dynamically allocated strings.

use canarytrap::TriggerSource;

assert_eq!(
    TriggerSource::from_static("reveal"),
    Ok(TriggerSource::Reveal)
);
assert_eq!(
    TriggerSource::from_static("custom:serde"),
    Ok(TriggerSource::Custom("serde"))
);
assert!(TriggerSource::from_static("unknown-source").is_err());

Variants (Non-exhaustive)§

This enum is marked as 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.
§

Reveal

The canary value was accessed through an explicit reveal API.

§

WithValue

The canary value was accessed through a closure-based API.

§

Registry

The canary value was accessed through a registry lookup or dispatch.

§

Serialize

The canary value was accessed during serialization.

§

Custom(&'static str)

A user-defined trigger source.

Custom sources are serialized as custom:<name>.

Implementations§

Source§

impl TriggerSource

Source

pub const BUILT_IN: &'static [TriggerSource]

Built-in trigger sources supported by this version of the crate.

This list does not include TriggerSource::Custom.

use canarytrap::TriggerSource;

assert!(!TriggerSource::BUILT_IN.is_empty());
assert!(TriggerSource::BUILT_IN.iter().all(TriggerSource::is_builtin));
Source

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

Creates a user-defined trigger source.

The name should be a stable identifier. It is serialized with a custom: prefix by the Display implementation.

use canarytrap::TriggerSource;

let source = TriggerSource::custom("serde");
assert_eq!(source.to_string(), "custom:serde");
Source

pub fn from_static(input: &'static str) -> Result<Self, ParseTriggerSourceError>

Parses a trigger source from a static string.

Built-in sources are parsed case-insensitively and accept common aliases. Custom sources must use the custom: prefix.

use canarytrap::TriggerSource;

assert_eq!(
    TriggerSource::from_static("with-value"),
    Ok(TriggerSource::WithValue)
);
assert_eq!(
    TriggerSource::from_static("CUSTOM:serde"),
    Ok(TriggerSource::Custom("serde"))
);
assert!(TriggerSource::from_static("not-a-source").is_err());
Source

pub fn as_builtin_str(&self) -> Option<&'static str>

Returns the canonical string representation for built-in sources.

Returns None for TriggerSource::Custom.

use canarytrap::TriggerSource;

assert_eq!(TriggerSource::Reveal.as_builtin_str(), Some("reveal"));
assert_eq!(TriggerSource::custom("serde").as_builtin_str(), None);
Source

pub fn as_custom_str(&self) -> Option<&'static str>

Returns the custom source name if this is a custom trigger source.

use canarytrap::TriggerSource;

assert_eq!(TriggerSource::custom("serde").as_custom_str(), Some("serde"));
assert_eq!(TriggerSource::Reveal.as_custom_str(), None);
Source

pub fn is_builtin(&self) -> bool

Returns true if this is a built-in trigger source.

use canarytrap::TriggerSource;

assert!(TriggerSource::Registry.is_builtin());
assert!(!TriggerSource::custom("serde").is_builtin());
Source

pub fn is_custom(&self) -> bool

Returns true if this is a user-defined trigger source.

use canarytrap::TriggerSource;

assert!(TriggerSource::custom("serde").is_custom());
assert!(!TriggerSource::Serialize.is_custom());

Trait Implementations§

Source§

impl Clone for TriggerSource

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for TriggerSource

Source§

impl Debug for TriggerSource

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for TriggerSource

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for TriggerSource

Source§

impl Hash for TriggerSource

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for TriggerSource

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

Restrict a value to a certain interval. Read more
Source§

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. Read more
Source§

impl PartialEq for TriggerSource

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for TriggerSource

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for TriggerSource

Source§

impl TryFrom<&'static str> for TriggerSource

Source§

type Error = ParseTriggerSourceError

The type returned in the event of a conversion error.
Source§

fn try_from(value: &'static str) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.