birl/time

Types

Month

pub type Month {
  January
  February
  March
  April
  May
  June
  July
  August
  September
  October
  November
  December
}

Constructors

```
January
```
```
February
```
```
March
```
```
April
```
```
May
```
```
June
```
```
July
```
```
August
```
```
September
```
```
October
```
```
November
```
```
December
```

Time

</>

pub opaque type Time

Weekday

</>

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

Constructors

```
Monday
```
```
Tuesday
```
```
Wednesday
```
```
Thursday
```
```
Friday
```
```
Saturday
```
```
Sunday
```

Constants

unix_epoch

</>

pub const unix_epoch: Time = Time(0, 0, option.None)

starting point of unix timestamps

Functions

add

</>

pub fn add(value: Time, duration: Duration) -> Time

compare

</>

pub fn compare(a: Time, b: Time) -> Order

difference

</>

pub fn difference(a: Time, b: Time) -> Duration

from_http

</>

pub fn from_http(value: String) -> Result(Time, Nil)

see here

from_iso8601

</>

pub fn from_iso8601(value: String) -> Result(Time, Nil)

from_unix

</>

pub fn from_unix(value: Int) -> Time

unix timestamps are the number of seconds that have elapsed since 00:00:00 UTC on January 1st, 1970

get_date

</>

pub fn get_date(value: Time) -> #(Int, Int, Int)

get_offset

</>

pub fn get_offset(value: Time) -> String

get_time

</>

pub fn get_time(value: Time) -> #(Int, Int, Int, Int)

month

</>

pub fn month(value: Time) -> Month

now

</>

pub fn now() -> Time

use this to get the current time in the local timezone offset

now_with_offset

</>

pub fn now_with_offset(offset: String) -> Result(Time, Nil)

use this to get the current time with a given offset.

Some examples of acceptable offsets:

"+330", "03:30", "-8:00","-7", "-0400", "03"

range

</>

pub fn range(from a: Time, to b: Option(Time), step s: Duration) -> Iterator(
  Time,
)

can be used to create a time range starting from time a with step s

if b is option.None the range will be infinite

set_date

</>

pub fn set_date(value: Time, new_date: #(Int, Int, Int)) -> Time

set_offset

</>

pub fn set_offset(value: Time, new_offset: String) -> Result(
  Time,
  Nil,
)

use this tp change the offset of a given time value.

Some examples of acceptable offsets:

"+330", "03:30", "-8:00","-7", "-0400", "03", "Z"

set_time

</>

pub fn set_time(value: Time, new_time: #(Int, Int, Int, Int)) -> Time

short_string_month

</>

pub fn short_string_month(value: Time) -> String

short_string_weekday

</>

pub fn short_string_weekday(value: Time) -> String

string_month

</>

pub fn string_month(value: Time) -> String

string_weekday

</>

pub fn string_weekday(value: Time) -> String

subtract

</>

pub fn subtract(value: Time, duration: Duration) -> Time

to_http

</>

pub fn to_http(value: Time) -> String

see here

to_iso8601

</>

pub fn to_iso8601(value: Time) -> String

to_unix

</>

pub fn to_unix(value: Time) -> Int

unix timestamps are the number of seconds that have elapsed since 00:00:00 UTC on January 1st, 1970

utc_now

</>

pub fn utc_now() -> Time

use this to get the current time in utc

weekday

</>

pub fn weekday(value: Time) -> Weekday