TermText¶

Use this primitive directly to format strings.

primitive val TermText is
  TerminalTextFormatting ref

Implements¶

TerminalTextFormatting ref

Constructors¶

create¶

[Source]

new val create()
: TermText val^

Returns¶

TermText val^

Public Functions¶

hide¶

[Source]

fun box hide(
  value: Stringable val)
: String val

Parameters¶

value: Stringable val

Returns¶

String val

conceal¶

[Source]

fun box conceal(
  value: Stringable val)
: String val

Parameters¶

value: Stringable val

Returns¶

String val

bold¶

[Source]

fun box bold(
  value: Stringable val)
: String val

Parameters¶

value: Stringable val

Returns¶

String val

faint¶

[Source]

fun box faint(
  value: Stringable val)
: String val

Parameters¶

value: Stringable val

Returns¶

String val

invert¶

[Source]

fun box invert(
  value: Stringable val)
: String val

Parameters¶

value: Stringable val

Returns¶

String val

italics¶

[Source]

fun box italics(
  value: Stringable val)
: String val

Parameters¶

value: Stringable val

Returns¶

String val

underline¶

[Source]

fun box underline(
  value: Stringable val)
: String val

Parameters¶

value: Stringable val

Returns¶

String val

strikeout¶

[Source]

fun box strikeout(
  value: Stringable val)
: String val

Parameters¶

value: Stringable val

Returns¶

String val

color¶

[Source]

fun box color(
  value: Stringable val,
  fg: U8 val,
  bg: (None val | U8 val) = reference)
: String val

Parameters¶

value: Stringable val
fg: U8 val
bg: (None val | U8 val) = reference

Returns¶

String val

color_with¶

[Source]

fun box color_with(
  value: Stringable val,
  fg: String val,
  bg: (None val | String val) = reference)
: String val

Parameters¶

value: Stringable val
fg: String val
bg: (None val | String val) = reference

Returns¶

String val

eq¶

[Source]

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

Parameters¶

that: TermText val

Returns¶

Bool val

ne¶

[Source]

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

Parameters¶

that: TermText val

Returns¶

Bool val