calendar/date

Types

Date

A Date struct and functions.

The Date struct contains the fields year, month, day and calendar. New dates can be built with the new function.

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

Constructors

Date(year: Int, month: Int, day: Int, calendar: String)

DateError

</>

pub type DateError {
  InvalidDate
  InvalidYear
  InvalidMonth
  InvalidDay
  InvalidFormat
  InvalidCalendar
  IncompatibleCalendars
}

Constructors

```
InvalidDate
```
```
InvalidYear
```
```
InvalidMonth
```
```
InvalidDay
```
```
InvalidFormat
```
```
InvalidCalendar
```
```
IncompatibleCalendars
```

DateFormat

</>

pub type DateFormat {
  Extended
  Basic
}

Constructors

```
Extended
```
```
Basic
```

Values

add

</>

pub fn add(date: Date, days: Int) -> Date

Adds the number of days to the given date.

add_days

</>

pub fn add_days(date: Date, days: Int) -> Result(Date, DateError)

Add days to a date.

after

</>

pub fn after(date1: Date, date2: Date) -> Bool

Returns true if the first date is strictly later than the second.

before

</>

pub fn before(date1: Date, date2: Date) -> Bool

Returns true if the first date is strictly earlier than the second.

beginning_of_month

</>

pub fn beginning_of_month(date: Date) -> Date

Calculates a date that is the first day of the month for the given date.

beginning_of_week

</>

pub fn beginning_of_week(date: Date) -> Date

Calculates a date that is the first day of the week for the given date.

beginning_of_week_starting_on

</>

pub fn beginning_of_week_starting_on(
  date: Date,
  starting_on: Int,
) -> Date

Calculates beginning of week with custom starting day.

compare

</>

pub fn compare(date1: Date, date2: Date) -> order.Order

Compare two dates. Returns order.Lt, order.Eq, or order.Gt.

convert

</>

pub fn convert(
  date: Date,
  target_calendar: String,
) -> Result(Date, DateError)

Converts the given date from its calendar to the given calendar.

day_of_era

</>

pub fn day_of_era(date: Date) -> #(Int, Int)

Calculates the day-of-era and era for a given calendar date.

day_of_week

</>

pub fn day_of_week(date: Date) -> Int

Calculates the ordinal day of the week of a given date.

day_of_week_starting_on

</>

pub fn day_of_week_starting_on(
  date: Date,
  starting_on: Int,
) -> Int

Calculates the ordinal day of the week with custom starting day.

day_of_year

</>

pub fn day_of_year(date: Date) -> Int

Calculates the day of the year of a given date.

days_in_month

</>

pub fn days_in_month(year: Int, month: Int) -> Int

Returns the number of days in a given month and year.

days_in_month_for_date

</>

pub fn days_in_month_for_date(date: Date) -> Int

Returns the number of days in the given date month.

diff

</>

pub fn diff(date1: Date, date2: Date) -> Int

Calculates the difference between two dates, in a full number of days.

end_of_month

</>

pub fn end_of_month(date: Date) -> Date

Calculates a date that is the last day of the month for the given date.

end_of_week

</>

pub fn end_of_week(date: Date) -> Date

Calculates a date that is the last day of the week for the given date.

end_of_week_starting_on

</>

pub fn end_of_week_starting_on(
  date: Date,
  starting_on: Int,
) -> Date

Calculates end of week with custom starting day.

from_days_since_unix_epoch

</>

pub fn from_days_since_unix_epoch(
  days: Int,
  calendar: String,
) -> Result(Date, DateError)

Create a date from days since Unix epoch (1970-01-01).

from_erl

</>

pub fn from_erl(
  tuple: #(Int, Int, Int),
) -> Result(Date, DateError)

Converts an Erlang date tuple to a Date struct.

from_erl_with_calendar

</>

pub fn from_erl_with_calendar(
  tuple: #(Int, Int, Int),
  calendar: String,
) -> Result(Date, DateError)

Converts an Erlang date tuple to a Date struct with specified calendar.

from_gregorian_days

</>

pub fn from_gregorian_days(days: Int) -> Date

Converts a number of gregorian days to a Date struct.

from_gregorian_days_with_calendar

</>

pub fn from_gregorian_days_with_calendar(
  days: Int,
  calendar: String,
) -> Date

Converts a number of gregorian days to a Date struct with specified calendar.

from_iso8601

</>

pub fn from_iso8601(string: String) -> Result(Date, DateError)

Parses an ISO 8601 date string.

from_iso8601_with_calendar

</>

pub fn from_iso8601_with_calendar(
  string: String,
  calendar: String,
) -> Result(Date, DateError)

Parses an ISO 8601 date string with specified calendar.

from_timestamp

</>

pub fn from_timestamp(timestamp: Int) -> Result(Date, DateError)

Create a date from Unix timestamp (seconds since epoch).

is_leap_year

</>

pub fn is_leap_year(year: Int) -> Bool

Checks if a year is a leap year.

leap_year

</>

pub fn leap_year(date: Date) -> Bool

Returns true if the year in the given date is a leap year.

months_in_year

</>

pub fn months_in_year(date: Date) -> Int

Returns the number of months in the given date year.

new

</>

pub fn new(
  year: Int,
  month: Int,
  day: Int,
  calendar: String,
) -> Result(Date, DateError)

Creates a new Date struct.

new_iso

</>

pub fn new_iso(
  year: Int,
  month: Int,
  day: Int,
) -> Result(Date, DateError)

Creates a new Date struct with ISO calendar as default.

new_simple

</>

pub fn new_simple(
  year: Int,
  month: Int,
  day: Int,
) -> Result(Date, DateError)

Creates a new Date struct with ISO calendar as default.

quarter_of_year

</>

pub fn quarter_of_year(date: Date) -> Int

Calculates the quarter of the year of a given date.

range

</>

pub fn range(
  first: Date,
  last: Date,
) -> Result(List(Date), DateError)

Creates a date range between two dates.

range_with_step

</>

pub fn range_with_step(
  first: Date,
  last: Date,
  step: Int,
) -> Result(List(Date), DateError)

Creates a date range with a step.

shift

</>

pub fn shift(
  date: Date,
  duration: duration.Duration,
) -> Result(Date, DateError)

Shifts given date by duration according to its calendar.

subtract_days

</>

pub fn subtract_days(
  date: Date,
  days: Int,
) -> Result(Date, DateError)

Subtract days from a date.

to_erl

</>

pub fn to_erl(date: Date) -> #(Int, Int, Int)

Converts the given date to an Erlang date tuple.

to_gregorian_days

</>

pub fn to_gregorian_days(date: Date) -> Int

Converts a date struct to a number of gregorian days.

to_iso8601

</>

pub fn to_iso8601(date: Date) -> String

Converts a Date to ISO8601 format.

to_iso8601_with_format

</>

pub fn to_iso8601_with_format(
  date: Date,
  format: DateFormat,
) -> String

Converts the given date to ISO 8601 with format option.

to_string

</>

pub fn to_string(date: Date) -> String

Converts a Date to a string in ISO8601 format (YYYY-MM-DD).

to_timestamp

</>

pub fn to_timestamp(date: Date) -> Int

Convert date to Unix timestamp (approximation).

utc_today

</>

pub fn utc_today() -> Date

Returns the current date in UTC.

utc_today_with_calendar

</>

pub fn utc_today_with_calendar(calendar: String) -> Date

Returns the current date in UTC with specified calendar.

year_of_era

</>

pub fn year_of_era(date: Date) -> #(Int, Int)

Calculates the year-of-era and era for a given calendar year.