@zeroc/ice
    Preparing search index...

    Class ToStringMode

    The output mode for xxxToString methods such as identityToString and proxyToString. The actual encoding format for the string is the same for all modes: you don't need to specify an encoding format or mode when reading such a string.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    Methods

    Constructors

    • Constructs a new enumerator.

      Parameters

      • name: string

        The name of the enumerator.

      • value: number

        The numeric value of the enumerator.

      Returns ToStringMode

    Properties

    name: string

    The name of the enumerator.

    value: number

    The value of the enumerator.

    Characters with ordinal values greater than 127 are encoded as universal character names in the resulting string: \unnnn for BMP characters and \Unnnnnnnn for non-BMP characters. Non-printable ASCII characters with ordinal values 127 and below are encoded as \t, \n (etc.) or \unnnn.

    Compat: ToStringMode

    Characters with ordinal values greater than 127 are encoded as a sequence of UTF-8 bytes using octal escapes. Characters with ordinal values 127 and below are encoded as \t, \n (etc.) or an octal escape. Use this mode to generate strings compatible with Ice 3.6 and earlier.

    Unicode: ToStringMode

    Characters with ordinal values greater than 127 are kept as-is in the resulting string. Non-printable ASCII characters with ordinal values 127 and below are encoded as \t, \n (etc.) or \unnnn.

    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 ToStringMode

      The enumerator for the given value.