Struct switchboard_utils::protos::oracle_job::CronParseTask

pub struct CronParseTask {
    pub cron_pattern: Option<String>,
    pub clock_offset: Option<i32>,
    pub clock: Option<i32>,
}

Return a timestamp from a crontab instruction.

Input: None

Returns: A timestamp

Example: Return the unix timestamp for the on-chain SYSCLOCK

{"cronParseTask":{"cronPattern":"* * * * * *","clockOffset":0,"clock":"SYSCLOCK"}}

Example: Return the unix timestamp for next friday at 5pm UTC

{"cronParseTask":{"cronPattern":"0 17 * * 5","clockOffset":0,"clock":0}}

Fields

cron_pattern: Option<String>

/ The cron pattern to parse.

clock_offset: Option<i32>

/ The timestamp offset to calculate the next run.

clock: Option<i32>

/ Use the TaskRunner’s clock or the on-chain SYSCLOCK.

Implementations

impl CronParseTask

pub fn cron_pattern(&self) -> &str

Returns the value of cron_pattern, or the default value if cron_pattern is unset.

pub fn clock_offset(&self) -> i32

Returns the value of clock_offset, or the default value if clock_offset is unset.

pub fn clock(&self) -> ClockType

Returns the enum value of clock, or the default if the field is unset or set to an invalid enum value.

pub fn set_clock(&mut self, value: ClockType)

Sets clock to the provided enum value.

Trait Implementations

impl Clone for CronParseTask

fn clone(&self) -> CronParseTask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CronParseTask

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

Formats the value using the given formatter.

impl Default for CronParseTask

fn default() -> Self

Returns the “default value” for a type.

impl Message for CronParseTask

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for CronParseTask

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

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

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 CronParseTask