Skip to content

tz

class Period

Period¶

A calendar interval: months + days + nanoseconds.

Per T7, Period carries intraday units (nanoseconds) so a single type covers "every 1 month" and "every 90 minutes" alike. Application to a date or zoned date-time goes through an OverflowPolicy.

Two Periods are equal when all three components match. Periods do NOT support compare/lt/gt — "1 month vs 30 days" has no answer without a date to apply both against, so semantic ordering is intentionally absent. Apply both to a date and compare the results if you need it.

class val Period

Constructors¶

create¶

new val create(
  months': I32 val = 0,
  days': I32 val = 0,
  nanos': I64 val = 0)
: Period val^

Parameters¶

months': I32 val = 0
days': I32 val = 0
nanos': I64 val = 0

Returns¶

Period val^

zero¶

The zero period: every component is zero.

new val zero()
: Period val^

Returns¶

Period val^

of_months¶

new val of_months(
  m: I32 val)
: Period val^

Parameters¶

m: I32 val

Returns¶

Period val^

of_days¶

new val of_days(
  d: I32 val)
: Period val^

Parameters¶

d: I32 val

Returns¶

Period val^

of_hours¶

new val of_hours(
  h: I64 val)
: Period val^

Parameters¶

h: I64 val

Returns¶

Period val^

of_minutes¶

new val of_minutes(
  m: I64 val)
: Period val^

Parameters¶

m: I64 val

Returns¶

Period val^

of_seconds¶

new val of_seconds(
  s: I64 val)
: Period val^

Parameters¶

s: I64 val

Returns¶

Period val^

of_nanos¶

new val of_nanos(
  n: I64 val)
: Period val^

Parameters¶

n: I64 val

Returns¶

Period val^

Public Functions¶

months¶

fun val months()
: I32 val

Returns¶

I32 val

days¶

fun val days()
: I32 val

Returns¶

I32 val

nanos¶

fun val nanos()
: I64 val

Returns¶

I64 val

is_zero¶

True if every component is zero.

fun val is_zero()
: Bool val

Returns¶

Bool val

eq¶

fun val eq(
  other: Period val)
: Bool val

Parameters¶

other: Period val

Returns¶

Bool val

ne¶

fun val ne(
  other: Period val)
: Bool val

Parameters¶

other: Period val

Returns¶

Bool val

neg¶

Return -this: every component negated.

fun val neg()
: Period val

Returns¶

Period val

add¶

Component-wise addition. Overflow wraps (Pony default +).

fun val add(
  other: Period val)
: Period val

Parameters¶

other: Period val

Returns¶

Period val

sub¶

Component-wise subtraction.

fun val sub(
  other: Period val)
: Period val

Parameters¶

other: Period val

Returns¶

Period val

mul¶

Multiply every component by scalar n. Overflow wraps.

fun val mul(
  n: I32 val)
: Period val

Parameters¶

n: I32 val

Returns¶

Period val

string¶

Debug-style representation: "Period(months=N, days=N, nanos=N)". Not ISO 8601 Duration format — that's a TODO; the negative-with- fractional-seconds case is fiddly enough to want its own design pass.

fun val string()
: String iso^

Returns¶

String iso^