Logo Xantham

Brand Module

Crossing the brand boundary. Every operation here is an erased cast: it changes what the type checker will accept and nothing about the value.

Functions and values

Function or value Description

tagBool value

Full Usage: tagBool value

Parameters:
    value : bool

Returns: bool<'m>
Modifiers: inline
Type parameters: 'm

Apply a brand to a raw bool.

value : bool
Returns: bool<'m>

tagChar value

Full Usage: tagChar value

Parameters:
    value : char

Returns: char<'m>
Modifiers: inline
Type parameters: 'm

Apply a brand to a raw char.

value : char
Returns: char<'m>

tagString value

Full Usage: tagString value

Parameters:
    value : string

Returns: string<'m>
Modifiers: inline
Type parameters: 'm

Apply a brand to a raw string.

value : string
Returns: string<'m>

untagBool value

Full Usage: untagBool value

Parameters:
Returns: bool
Modifiers: inline
Type parameters: 'm

Drop the brand from a bool, recovering the primitive.

value : bool<'m>
Returns: bool

untagChar value

Full Usage: untagChar value

Parameters:
Returns: char
Modifiers: inline
Type parameters: 'm

Drop the brand from a char, recovering the primitive.

value : char<'m>
Returns: char

untagString value

Full Usage: untagString value

Parameters:
Returns: string
Modifiers: inline
Type parameters: 'm

Drop the brand from a string, recovering the primitive.

value : string<'m>
Returns: string

Type something to start searching.