clockwork

clockwork

Types

Cron

</> 
pub type Cron {
  Cron(
    minute: CronField,
    hour: CronField,
    day: CronField,
    month: CronField,
    weekday: CronField,
  )
}

Constructors 

  • Cron(
  minute: CronField,
  hour: CronField,
  day: CronField,
  month: CronField,
  weekday: CronField,
)

CronField

opaque </> 
pub opaque type CronField

Functions

default

</> 
pub fn default() -> Cron

Default cron struct with all fields set to wildcard.

every

</> 
pub fn every(step: Int) -> CronField

every_time

</> 
pub fn every_time() -> CronField

Wildcard field for a cron struct.

exactly

</> 
pub fn exactly(at v: Int) -> CronField

Value field for a cron struct.

from_string

</> 
pub fn from_string(cron: String) -> Result(Cron, Nil)

Parse a cron string into a Cron struct.

list

</> 
pub fn list(fields: List(CronField)) -> CronField

List field for a cron struct.

next_occurrence

</> 
pub fn next_occurrence(
  given cron: Cron,
  from from: Timestamp,
  with_offset offset: Duration,
) -> Timestamp

Returns the next occurrence of a cron job after the given timestamp.

ranging

</> 
pub fn ranging(from start: Int, to end: Int) -> CronField

Range field for a cron struct.

ranging_every

</> 
pub fn ranging_every(
  step: Int,
  from start: Int,
  to end: Int,
) -> CronField

stepping

</> 
pub fn stepping(every step: Int, from from: Int) -> CronField

to_string

</> 
pub fn to_string(cron: Cron) -> String

Convert a Cron struct into a cron string.

with_day

</> 
pub fn with_day(cron: Cron, day: CronField) -> Cron

Set the day field of a cron struct.

with_hour

</> 
pub fn with_hour(cron: Cron, hour: CronField) -> Cron

Set the hour field of a cron struct.

with_minute

</> 
pub fn with_minute(cron: Cron, minute: CronField) -> Cron

Set the minute field of a cron struct.

with_month

</> 
pub fn with_month(cron: Cron, month: CronField) -> Cron

Set the month field of a cron struct.

with_weekday

</> 
pub fn with_weekday(cron: Cron, weekday: CronField) -> Cron

Set the weekday field of a cron struct. Weekdays are 0-indexed, starting from Sunday.

✨ Search Document