Esc

format

procedureextension2 overloadssince 0.36.1Source
  • macOS: format works on macOS
  • Linux: format works on Linux
  • Windows: format works on Windows
  • Wasm: format works on Wasm

overload 1

format :: (
    builder: *Builder,
    value: $T/ .[Date, Time_Of_Day, Date_Time, Timestamp, Signed_Duration, Offset, Time_Zone, Zoned, Span]
) -> Time_Error

Uses String_Builder. Appends canonical ISO text, trims fractional zeros and uses UTC Z for timestamps.

Example↗
instant, _ := timestamp_from_seconds(1710055800);
builder: String_Builder;
defer free_buffers(*builder);
error := format(*builder, instant);
assert(error.kind == .NONE);
text := builder_to_string(*builder);
defer free(text);
assert(text == "2024-03-10T07:30:00Z");

overload 2

format :: (
    builder: *Builder,
    value: $T/ .[Date, Time_Of_Day, Date_Time, Timestamp, Signed_Duration, Offset, Time_Zone, Zoned],
    pattern: string,
    options: Time_Options = .{}
) -> Time_Error

Appends English strftime text with the documented directive set and padding flags.

Example↗
wall := Date_Time.{ .{ 2024, 3, 10 }, .{ 2, 30, 0, 0 } };
builder: String_Builder;
defer free_buffers(*builder);
error := format(*builder, wall, "%A %b %-d, %H:%M");
assert(error.kind == .NONE);
text := builder_to_string(*builder);
defer free(text);
assert(text == "Sunday Mar 10, 02:30");

See also