validator

Types

EndCondition

pub type EndCondition {
  Forever
  Count(Int)
  Until(Until)
}

Constructors

```
Forever
```
```
Count(Int)
```
```
Until(Until)
```

Frequency

</>

pub type Frequency {
  Daily
  Weekly
  Monthly
  Yearly
}

Constructors

```
Daily
```
```
Weekly
```
```
Monthly
```
```
Yearly
```

RulePart

</>

pub type RulePart {
  FreqPart
  IntervalPart
  CountPart
  UntilPart
  ByDayPart
  ByMonthPart
  ByMonthDayPart
  ByHourPart
  ByMinutePart
}

Constructors

```
FreqPart
```
```
IntervalPart
```
```
CountPart
```
```
UntilPart
```
```
ByDayPart
```
```
ByMonthPart
```
```
ByMonthDayPart
```
```
ByHourPart
```
```
ByMinutePart
```

Until

</>

pub type Until {
  UntilDate(ast.Date)
  UntilDateTime(ast.DateTime)
}

Constructors

```
UntilDate(ast.Date)
```
```
UntilDateTime(ast.DateTime)
```

ValidRRule

opaque </>

An RRULE that has passed validate/1. opaque so the only way to obtain a value is through validation, preventing callers from forging “validated” inputs.

pub opaque type ValidRRule

ValidationError

</>

pub type ValidationError {
  MissingPart(part: RulePart)
  DuplicatePart(part: RulePart)
  UnknownPart(name: String)
  UnsupportedPart(name: String)
  InvalidNumber(part: RulePart, value: String)
  InvalidPartValue(part: RulePart, value: String)
  InvalidList(part: RulePart, value: String)
  OutOfRange(part: RulePart, min: Int, max: Int, actual: Int)
  MustBePositive(part: RulePart, actual: Int)
  MutuallyExclusiveParts(left: RulePart, right: RulePart)
  NumericWeekdayRequiresMonthlyOrYearly(frequency: Frequency)
  ImpossibleDate(by_month: String, by_month_day: String)
  IncompatibleFrequencyAndPart(
    frequency: Frequency,
    part: RulePart,
  )
}

Constructors

```
MissingPart(part: RulePart)
```
```
DuplicatePart(part: RulePart)
```
```
UnknownPart(name: String)
```
```
UnsupportedPart(name: String)
```

InvalidNumber(part: RulePart, value: String)

InvalidPartValue(part: RulePart, value: String)

InvalidList(part: RulePart, value: String)

OutOfRange(part: RulePart, min: Int, max: Int, actual: Int)

MustBePositive(part: RulePart, actual: Int)

MutuallyExclusiveParts(left: RulePart, right: RulePart)

NumericWeekdayRequiresMonthlyOrYearly(frequency: Frequency)

ImpossibleDate(by_month: String, by_month_day: String)

IncompatibleFrequencyAndPart(
  frequency: Frequency,
  part: RulePart,
)

WeekdaySpecifier

</>

pub type WeekdaySpecifier {
  EveryWeekday(ast.Weekday)
  NthWeekday(Int, ast.Weekday)
}

Constructors

```
EveryWeekday(ast.Weekday)
```
```
NthWeekday(Int, ast.Weekday)
```

Values

by_day

</>

pub fn by_day(
  spec: ValidRRule,
) -> option.Option(List(WeekdaySpecifier))

by_hour

</>

pub fn by_hour(spec: ValidRRule) -> option.Option(List(Int))

by_minute

</>

pub fn by_minute(spec: ValidRRule) -> option.Option(List(Int))

by_month

</>

pub fn by_month(spec: ValidRRule) -> option.Option(List(Int))

by_month_day

</>

pub fn by_month_day(spec: ValidRRule) -> option.Option(List(Int))

end_condition

</>

pub fn end_condition(spec: ValidRRule) -> EndCondition

frequency

</>

pub fn frequency(spec: ValidRRule) -> Frequency

interval

</>

pub fn interval(spec: ValidRRule) -> Int

to_string

</>

pub fn to_string(spec: ValidRRule) -> String

validate

</>

pub fn validate(
  raw raw: ast.RawRRule,
) -> Result(ValidRRule, ValidationError)