@zeroc/ice
    Preparing search index...

    Class FormatType

    This enumeration describes the possible formats for classes.

    Hierarchy (View Summary)

    Index

    Constructors

    • Constructs a new enumerator.

      Parameters

      • name: string

        The name of the enumerator.

      • value: number

        The numeric value of the enumerator.

      Returns FormatType

    Properties

    name: string

    The name of the enumerator.

    value: number

    The value of the enumerator.

    CompactFormat: FormatType

    The Compact format assumes the sender and receiver have the same Slice definitions for classes. If an application receives a derived class it does not know, it is not capable of decoding it into a known base class because there is not enough information in the encoded payload. The compact format is more space-efficient on the wire.

    SlicedFormat: FormatType

    The Sliced format allows the receiver to slice off unknown slices. If an application receives a derived class it does not know, it can create a base class while preserving the unknown derived slices.

    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 numeric value of the enumerator.

      Returns FormatType

      The enumerator corresponding to the given value.