Skip to main content

Trigger

Enum Trigger 

Source
pub enum Trigger {
    Account {
        address: Pubkey,
        offset: u64,
        size: u64,
    },
    Immediate {
        jitter: u64,
    },
    Timestamp {
        unix_ts: i64,
        jitter: u64,
    },
    Interval {
        seconds: i64,
        skippable: bool,
        jitter: u64,
    },
    Cron {
        schedule: String,
        skippable: bool,
        jitter: u64,
    },
    Slot {
        slot: u64,
    },
    Epoch {
        epoch: u64,
    },
}
Expand description

The triggering conditions of a thread.

Variants§

§

Account

Allows a thread to be kicked off whenever the data of an account changes.

Fields

§address: Pubkey

The address of the account to monitor.

§offset: u64

The byte offset of the account data to monitor.

§size: u64

The size of the byte slice to monitor (must be less than 1kb)

§

Immediate

Allows a thread to be kicked off as soon as it’s created.

Fields

§jitter: u64

Optional jitter in seconds to prevent thundering herd (0 = no jitter)

§

Timestamp

Allows a thread to be kicked off according to a unix timestamp.

Fields

§unix_ts: i64
§jitter: u64

Optional jitter in seconds to spread execution across a window (0 = no jitter)

§

Interval

Allows a thread to be kicked off at regular intervals.

Fields

§seconds: i64

Interval in seconds between executions

§skippable: bool

Boolean value indicating whether triggering moments may be skipped

§jitter: u64

Optional jitter in seconds to prevent thundering herd (0 = no jitter)

§

Cron

Allows a thread to be kicked off according to a one-time or recurring schedule.

Fields

§schedule: String

The schedule in cron syntax. Value must be parsable by the antegen_cron package.

§skippable: bool

Boolean value indicating whether triggering moments may be skipped if they are missed (e.g. due to network downtime). If false, any “missed” triggering moments will simply be executed as soon as the network comes back online.

§jitter: u64

Optional jitter in seconds to spread execution across a window (0 = no jitter)

§

Slot

Allows a thread to be kicked off according to a slot.

Fields

§slot: u64
§

Epoch

Allows a thread to be kicked off according to an epoch number.

Fields

§epoch: u64

Trait Implementations§

Source§

impl BorshDeserialize for Trigger

Source§

fn deserialize_reader<__R: Read>(reader: &mut __R) -> Result<Self, Error>

Source§

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.
Source§

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.
Source§

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>
where R: Read,

Source§

impl BorshSerialize for Trigger

Source§

fn serialize<__W: Write>(&self, writer: &mut __W) -> Result<(), Error>

Source§

impl Clone for Trigger

Source§

fn clone(&self) -> Trigger

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Trigger

Source§

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

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

impl EnumExt for Trigger

Source§

fn deserialize_variant<__R: Read>( reader: &mut __R, variant_tag: u8, ) -> Result<Self, Error>

Deserialises given variant of an enum from the reader. Read more
Source§

impl PartialEq for Trigger

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Space for Trigger

Source§

impl StructuralPartialEq for Trigger

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> Same for T

Source§

type Output = T

Should always be Self
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.