Esc

span_round

procedureextension3 overloadssince 0.36.1Source
  • macOS: span_round works on macOS
  • Linux: span_round works on Linux
  • Windows: span_round works on Windows
  • Wasm: span_round works on Wasm

overload 1

span_round :: (
    value: Span,
    smallest: Unit,
    largest: Unit,
    rounding := Rounding.HALF_EXPAND,
    increment: s64 = 1
) -> (Span, Time_Error)

Rounds to a positive increment, then balances; calendar rounding needs a relative value.

Example↗
span, error := span_round(.{ hours = 1, minutes = 40 }, .HOUR, .HOUR);
assert(error.kind == .NONE && span.hours == 2);

overload 2

span_round :: (
    value: Span,
    smallest: Unit,
    largest: Unit,
    rounding := Rounding.HALF_EXPAND,
    increment: s64 = 1,
    relative: Date
) -> (Span, Time_Error)

Uses a relative Date.

Example↗
span, error := span_round(.{ months = 1, days = 20 }, .MONTH, .MONTH, relative = Date.{ 2024, 1, 1 });
assert(error.kind == .NONE && span.months == 2);

overload 3

span_round :: (
    value: Span,
    smallest: Unit,
    largest: Unit,
    rounding := Rounding.HALF_EXPAND,
    increment: s64 = 1,
    relative: Zoned
) -> (Span, Time_Error)

Uses a relative Zoned.

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);
start, _ := to_zoned(.{ .{ 2024, 3, 10 }, .{ 0, 0, 0, 0 } }, zone);
span, error := span_round(.{ hours = 12 }, .DAY, .DAY, relative = start);
assert(error.kind == .NONE && span.days == 1);

See also