Format

Provides functions for generating formatted strings.

  • fmt. Format to use.
  • prefix. Prefix to use.
  • prec. Precision to use. The exact meaning of this depends on the type, but is generally the number of characters used for all, or part, of the string. A value of -1 indicates that the default for the type should be used.
  • width. The minimum number of characters that will be in the produced string. If necessary the string will be padded with the fill character to make it long enough. align. Specify whether fill characters should be added at the beginning or end of the generated string, or both. fill: The character to pad a string with if is is shorter than width.
primitive val Format

Constructors

create

new val create()
: Format val^

Returns


Public Functions

apply

fun box apply(
  str: String val,
  fmt: FormatDefault val = seq,
  prefix: PrefixDefault val = seq,
  prec: USize val = seq,
  width: USize val = seq,
  align: (AlignLeft val | AlignRight val | AlignCenter val) = seq,
  fill: U32 val = seq)
: String iso^

Parameters

Returns


int[A: ((I8 val | I16 val | I32 val | I64 val | I128 val | ILong val | ISize val | U8 val | U16 val | U32 val | U64 val | U128 val | ULong val | USize val) & Integer[A])]

fun box int[A: ((I8 val | I16 val | I32 val | 
    I64 val | I128 val | ILong val | 
    ISize val | U8 val | U16 val | 
    U32 val | U64 val | U128 val | 
    ULong val | USize val) & Integer[A])](
  x: A,
  fmt: (FormatDefault val | FormatUTF32 val | FormatBinary val | 
    FormatBinaryBare val | FormatOctal val | FormatOctalBare val | 
    FormatHex val | FormatHexBare val | FormatHexSmall val | 
    FormatHexSmallBare val) = seq,
  prefix: (PrefixDefault val | PrefixSpace val | PrefixSign val) = seq,
  prec: USize val = seq,
  width: USize val = seq,
  align: (AlignLeft val | AlignRight val | AlignCenter val) = seq,
  fill: U32 val = seq)
: String iso^

Parameters

Returns


float[A: ((F32 val | F64 val) & FloatingPoint[A])]

fun box float[A: ((F32 val | F64 val) & FloatingPoint[A])](
  x: A,
  fmt: (FormatDefault val | FormatExp val | FormatExpLarge val | 
    FormatFix val | FormatFixLarge val | FormatGeneral val | 
    FormatGeneralLarge val) = seq,
  prefix: (PrefixDefault val | PrefixSpace val | PrefixSign val) = seq,
  prec: USize val = seq,
  width: USize val = seq,
  align: (AlignLeft val | AlignRight val | AlignCenter val) = seq,
  fill: U32 val = seq)
: String iso^

Parameters

Returns


eq

fun box eq(
  that: Format val)
: Bool val

Parameters

Returns


ne

fun box ne(
  that: Format val)
: Bool val

Parameters

Returns