@zeroc/ice
    Preparing search index...

    Class OptionalFormat

    Optional format for encoding optional values.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    name value Class F1 F2 F4 F8 FSize Size VSize

    Methods

    toString valueOf

    Constructors

    • Constructs a new enumerator.

      Parameters

      • name: string

        The name of the enumerator.

      • value: number

        The numeric value of the enumerator.

      Returns OptionalFormat

    Properties

    name: string

    The name of the enumerator.

    value: number

    The value of the enumerator.

    Class: OptionalFormat

    Represents a class, but is no longer encoded or decoded.

    F1: OptionalFormat

    A fixed size numeric encoded on 1 byte.

    F2: OptionalFormat

    A fixed size numeric encoded on 2 byte.

    F4: OptionalFormat

    A fixed size numeric encoded on 4 byte.

    F8: OptionalFormat

    A fixed size numeric encoded on 8 byte.

    FSize: OptionalFormat

    A fixed length size (encoded on 4 bytes) followed by size bytes.

    Size: OptionalFormat

    A variable-length size encoded on 1 or 5 bytes.

    VSize: OptionalFormat

    A variable-length size followed by size bytes.

    Methods

    • Returns a string representation of the current enumerator.

      Returns string

      A string representation of the current enumerator.

    • Returns the enumerator for the given value.

      Parameters

      • value: number

        The enumerator value.

      Returns OptionalFormat

      The enumerator for the given value.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods