Enum clockwork_queue_program::objects::Trigger

pub enum Trigger {
    Account {
        address: Pubkey,
        offset: usize,
        size: usize,
    },
    Cron {
        schedule: String,
        skippable: bool,
    },
    Immediate,
}

The triggering conditions of a queue.

Variants

Account

Fields

address: Pubkey

The address of the account to monitor.

offset: usize

The byte offset of the account data to monitor.

size: usize

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

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

Cron

Fields

schedule: String

The schedule in cron syntax. Value must be parsable by the clockwork_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 cranked as soon as the network comes back online.

Allows a queue to be cranked according to a one-time or recurring schedule.

Immediate

Allows a queue to be cranked as soon as it’s created.

Trait Implementations

impl BorshDeserialize for Triggerwhere
    Pubkey: BorshDeserialize,
    usize: BorshDeserialize,
    usize: BorshDeserialize,
    String: BorshDeserialize,
    bool: BorshDeserialize,

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.

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

Deserialize this instance from a slice of bytes.

impl BorshSerialize for Triggerwhere
    Pubkey: BorshSerialize,
    usize: BorshSerialize,
    usize: BorshSerialize,
    String: BorshSerialize,
    bool: BorshSerialize,

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

fn try_to_vec(&self) -> Result<Vec<u8, Global>, Error>

Serialize this instance into a vector of bytes.

impl Clone for Trigger

fn clone(&self) -> Trigger

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Trigger

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

Formats the value using the given formatter.

impl PartialEq<Trigger> for Trigger

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Trigger