@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

    Class instance. No longer supported.

    F1: OptionalFormat

    Fixed 1-byte encoding.

    F2: OptionalFormat

    Fixed 2-byte encoding.

    F4: OptionalFormat

    Fixed 4-byte encoding.

    F8: OptionalFormat

    Fixed 8-byte encoding.

    FSize: OptionalFormat

    Fixed "size encoding" using 4 bytes followed by data. Used by variable-size structs, and containers whose sizes can't be computed prior to unmarshaling.

    Size: OptionalFormat

    "Size encoding" using either 1 or 5 bytes. Used by enums, class identifiers, etc.

    VSize: OptionalFormat

    Variable "size encoding" using either 1 or 5 bytes followed by data. Used by strings, fixed size structs, and containers whose size can be computed prior to marshaling.

    Methods

    • Returns a string representation of the current enumerator.

      Returns string

      A string representation of the current enumerator.

    • Returns the enumerator corresponding to the specified numeric value.

      Parameters

      • value: number

        The enumerator value.

      Returns OptionalFormat

      The matching enumerator, or undefined if no enumerator corresponds to the given value.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods