automata - v0.2.0

automata/schedule/ast

Types

Boundary

</>

Boundary semantics used when starting iteration.

Both variants wrap ValidDateTime so iterators can never be started from an impossible date such as 2026-02-30.

pub type Boundary {
  Inclusive(ValidDateTime)
  Exclusive(ValidDateTime)
}

Constructors

Date

</>

Calendar date in the proleptic Gregorian calendar.

pub type Date {
  Date(year: Int, month: Int, day: Int)
}

Constructors 

  • Date(year: Int, month: Int, day: Int)

DateTime

</>

Naive date-time used by schedule matching and iteration.

pub type DateTime {
  DateTime(date: Date, time: Time)
}

Constructors

DateTimeError

</>

Errors that can occur when smart-constructing DateTime values.

pub type DateTimeError {
  InvalidDate(year: Int, month: Int, day: Int)
  InvalidTime(hour: Int, minute: Int, second: Int)
}

Constructors 

  • InvalidDate(year: Int, month: Int, day: Int)
  • InvalidTime(hour: Int, minute: Int, second: Int)

Time

</>

Wall-clock time with second precision.

pub type Time {
  Time(hour: Int, minute: Int, second: Int)
}

Constructors 

  • Time(hour: Int, minute: Int, second: Int)

ValidDateTime

opaque </>

A DateTime proven to fall in the valid Gregorian range.

Construct via try_datetime/6; unwrap with valid_datetime_value/1.

pub opaque type ValidDateTime

Weekday

</>

Gregorian weekday names shared by cron and RRULE APIs.

pub type Weekday {
  Monday
  Tuesday
  Wednesday
  Thursday
  Friday
  Saturday
  Sunday
}

Constructors 

  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday

Values

date

</> 
pub fn date(
  year year: Int,
  month month: Int,
  day day: Int,
) -> Date

datetime

</> 
pub fn datetime(
  year year: Int,
  month month: Int,
  day day: Int,
  hour hour: Int,
  minute minute: Int,
  second second: Int,
) -> DateTime

time

</> 
pub fn time(
  hour hour: Int,
  minute minute: Int,
  second second: Int,
) -> Time

to_string

</> 
pub fn to_string(datetime: DateTime) -> String

try_datetime

</> 
pub fn try_datetime(
  year year: Int,
  month month: Int,
  day day: Int,
  hour hour: Int,
  minute minute: Int,
  second second: Int,
) -> Result(DateTime, DateTimeError)

Build a validated DateTime from raw integer components.

Returns Error(InvalidDate) for impossible calendar dates such as February 30, and Error(InvalidTime) for clock components outside 00:00:00-23:59:59.

try_valid_datetime

</> 
pub fn try_valid_datetime(
  year year: Int,
  month month: Int,
  day day: Int,
  hour hour: Int,
  minute minute: Int,
  second second: Int,
) -> Result(ValidDateTime, DateTimeError)

Build an opaque ValidDateTime, propagating validation errors.

valid_datetime_value

</> 
pub fn valid_datetime_value(valid: ValidDateTime) -> DateTime

Recover the raw DateTime value from a ValidDateTime.

weekday_to_string

</> 
pub fn weekday_to_string(weekday: Weekday) -> String
✨ Search Document