Esc

until

procedureextension4 overloadssince 0.36.1Source
  • macOS: until works on macOS
  • Linux: until works on Linux
  • Windows: until works on Windows
  • Wasm: until works on Wasm

overload 1

until :: (
    a: Date,
    b: Date,
    largest := Unit.DAY,
    smallest := Unit.NANOSECOND,
    rounding := Rounding.TRUNC,
    increment: s64 = 1
) -> (Span, Time_Error)

Measures b minus a; validates units, positive increments and range.

Example↗
a := Date.{ 2024, 1, 1 };
b := Date.{ 2024, 3, 1 };
days, _ := until(a, b);
assert(days.days == 60);
months, _ := until(a, b, largest = .MONTH);
assert(months.months == 2);

overload 2

until :: (
    a: Date_Time,
    b: Date_Time,
    largest := Unit.DAY,
    smallest := Unit.NANOSECOND,
    rounding := Rounding.TRUNC,
    increment: s64 = 1
) -> (Span, Time_Error)

Measures b minus a; validates units, positive increments and range.

Example↗
a := Date_Time.{ .{ 2024, 3, 10 }, .{ 1, 0, 0, 0 } };
b := Date_Time.{ .{ 2024, 3, 11 }, .{ 3, 30, 0, 0 } };
span, error := until(a, b);
assert(error.kind == .NONE && span.days == 1 && span.hours == 2 && span.minutes == 30);

overload 3

until :: (
    a: Timestamp,
    b: Timestamp,
    largest := Unit.SECOND,
    smallest := Unit.NANOSECOND,
    rounding := Rounding.TRUNC,
    increment: s64 = 1
) -> (Span, Time_Error)

Measures b minus a; validates units, positive increments and range.

Example↗
a, _ := timestamp_from_seconds(0);
b, _ := timestamp_from_seconds(3600);
span, error := until(a, b, largest = .MINUTE);
assert(error.kind == .NONE && span.minutes == 60);

overload 4

until :: (
    a: Zoned,
    b: Zoned,
    largest := Unit.DAY,
    smallest := Unit.NANOSECOND,
    rounding := Rounding.TRUNC,
    increment: s64 = 1,
    disambiguation := Disambiguation.COMPATIBLE
) -> (Span, Time_Error)

Measures b minus a; calendar units use the receiver's zone and real day lengths.

Example↗
zone, zone_error := time_zone_from_posix("EST5EDT,M3.2.0,M11.1.0");
assert(zone_error.kind == .NONE);
defer time_zone_free(*zone);
a, _ := to_zoned(.{ .{ 2024, 3, 9 }, .{ 12, 0, 0, 0 } }, zone);
b, _ := to_zoned(.{ .{ 2024, 3, 10 }, .{ 12, 0, 0, 0 } }, zone);
days, _ := until(a, b);
hours, _ := until(a, b, largest = .HOUR);
assert(days.days == 1 && hours.hours == 23);

See also