birl/duration

Types

Duration

An alias for gleam_time’s Duration type, representing a span of time in nanoseconds.

pub type Duration =
  duration.Duration

Unit

</>

pub type Unit {
  NanoSecond
  MicroSecond
  MilliSecond
  Second
  Minute
  Hour
  Day
  Week
  Month
  Year
}

Constructors

```
NanoSecond
```
```
MicroSecond
```
```
MilliSecond
```
```
Second
```
```
Minute
```
```
Hour
```
```
Day
```
```
Week
```
```
Month
```
```
Year
```

Values

accurate_decompose

</>

pub fn accurate_decompose(
  duration: duration.Duration,
) -> List(#(Int, Unit))

use this if you need very long durations where small inaccuracies could lead to large errors

accurate_new

</>

pub fn accurate_new(
  values: List(#(Int, Unit)),
) -> duration.Duration

use this if you need very long durations where small inaccuracies could lead to large errors

add

</>

pub fn add(
  a: duration.Duration,
  b: duration.Duration,
) -> duration.Duration

blur

</>

pub fn blur(duration: duration.Duration) -> #(Int, Unit)

approximates the duration by a value in a single unit

blur_to

</>

pub fn blur_to(duration: duration.Duration, unit: Unit) -> Int

approximates the duration by only the given unit

if the duration is not an integer multiple of the unit, the remainder will be disgarded if it’s less than two thirds of the unit, otherwise a single unit will be added to the multiplier.

blur_to(days(16), Month) -> 0
blur_to(days(20), Month) -> 1

compare

</>

pub fn compare(
  a: duration.Duration,
  b: duration.Duration,
) -> order.Order

days

</>

pub fn days(value: Int) -> duration.Duration

decompose

</>

pub fn decompose(
  duration: duration.Duration,
) -> List(#(Int, Unit))

use this if you need short durations where a year just means 365 days and a month just means 30 days

from_gleam_duration

</>

pub fn from_gleam_duration(
  d: duration.Duration,
) -> duration.Duration

Deprecated: Duration is now gleam_time's Duration type. This function is a no-op.

Convert gleam_time Duration to birl Duration.

Deprecated: Duration is the same type as gleam_time Duration. This function exists for backward compatibility and is a no-op.

hours

</>

pub fn hours(value: Int) -> duration.Duration

micro_seconds

</>

pub fn micro_seconds(value: Int) -> duration.Duration

milli_seconds

</>

pub fn milli_seconds(value: Int) -> duration.Duration

minutes

</>

pub fn minutes(value: Int) -> duration.Duration

months

</>

pub fn months(value: Int) -> duration.Duration

nano_seconds

</>

pub fn nano_seconds(value: Int) -> duration.Duration

new

</>

pub fn new(values: List(#(Int, Unit))) -> duration.Duration

use this if you need short durations where a year just means 365 days and a month just means 30 days

parse

</>

pub fn parse(
  expression: String,
) -> Result(duration.Duration, Nil)

you can use this function to create a new duration using expressions like:

"accurate: 1 Year - 2days + 152M -1h + 25 years + 25secs"

where the units are:

Year:         y, Y, YEAR, years, Years, ...

Month:        mon, Month, mONths, ...

Week:         w, W, Week, weeks, ...

Day:          d, D, day, Days, ...

Hour:         h, H, Hour, Hours, ...

Minute:       m, M, Min, minute, Minutes, ...

Second:       s, S, sec, Secs, second, Seconds, ...

MilliSecond:  ms, Msec, mSecs, milliSecond, MilliSecond, ...

numbers with no unit are considered as nanoseconds. specifying accurate: is equivalent to using accurate_new.

scale_down

</>

pub fn scale_down(
  value: duration.Duration,
  factor: Int,
) -> duration.Duration

scale_up

</>

pub fn scale_up(
  value: duration.Duration,
  factor: Int,
) -> duration.Duration

seconds

</>

pub fn seconds(value: Int) -> duration.Duration

subtract

</>

pub fn subtract(
  a: duration.Duration,
  b: duration.Duration,
) -> duration.Duration

to_gleam_duration

</>

pub fn to_gleam_duration(
  d: duration.Duration,
) -> duration.Duration

Deprecated: Duration is now gleam_time's Duration type. This function is a no-op.

Convert birl Duration to gleam_time Duration.

Deprecated: Duration is the same type as gleam_time Duration. This function exists for backward compatibility and is a no-op.

weeks

</>

pub fn weeks(value: Int) -> duration.Duration

years

</>

pub fn years(value: Int) -> duration.Duration