Enum TriggerConfig 

#[non_exhaustive]
pub enum TriggerConfig {
    Every {
        interval: Duration,
    },
    OnFileChange {
        path: PathBuf,
    },
}

Configuration for a trigger that the SDK will run.

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.

Every

Periodic trigger: fires every interval.

Fields

interval: Duration

Interval between firings.

OnFileChange

File-change trigger: fires when files change under path.

Fields

path: PathBuf

Directory to watch for changes.

Implementations

impl TriggerConfig

pub const fn every_secs(secs: u64) -> Self

👎Deprecated since 0.2.0:

Use try_every(Duration::from_secs(secs)) instead, which returns Result

Create an Every trigger from a number of seconds.

Panics

Panics if secs is 0.

pub fn every(duration: Duration) -> Self

👎Deprecated since 0.2.0:

Use try_every() instead, which returns Result

Create an Every trigger with a specific Duration.

Panics

Panics if the duration is less than 1 second.

pub fn on_file_change(path: impl Into<PathBuf>) -> Self

👎Deprecated since 0.2.0:

Use try_on_file_change() instead, which returns Result

Create an OnFileChange trigger watching the given directory.

Panics

Panics if path is empty, relative, or contains ...

pub fn try_on_file_change(path: impl Into<PathBuf>) -> Result<Self, Error>

Fallible version of on_file_change.

Errors

Returns Error::InvalidConfig if path is empty, relative, or contains ...

pub fn try_every(duration: Duration) -> Result<Self, Error>

Fallible version of every.

Errors

Returns Error::InvalidConfig if the duration is less than 1 second.

pub fn description(&self) -> String

Human-readable description for logging.

Trait Implementations

impl Clone for TriggerConfig

fn clone(&self) -> TriggerConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TriggerConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TriggerConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for TriggerConfig

impl PartialEq for TriggerConfig

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TriggerConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TriggerConfig