Esc

span_total

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

overload 1

span_total :: (value: Span, unit: Unit) -> (float64, Time_Error)

Returns a possibly fractional total; zoned days follow actual day lengths.

Example↗
hours, error := span_total(.{ hours = 1, minutes = 30 }, .HOUR);
assert(error.kind == .NONE && hours == 1.5);

overload 2

span_total :: (
    value: Span,
    unit: Unit,
    relative: Date
) -> (float64, Time_Error)

Uses a relative Date.

Example↗
days, error := span_total(.{ months = 1 }, .DAY, Date.{ 2024, 2, 1 });
assert(error.kind == .NONE && days == 29);

overload 3

span_total :: (
    value: Span,
    unit: Unit,
    relative: Zoned
) -> (float64, 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);
hours, error := span_total(.{ days = 1 }, .HOUR, start);
assert(error.kind == .NONE && hours == 23);

See also