Interface BinaryFormat

BinaryFormat is the contract for serializing messages to and from binary data. Implementations may be specific to a proto syntax, and can be reflection based, or delegate to speed optimized generated code.

Hierarchy

  • BinaryFormat

Methods

discardUnknownFields listUnknownFields makeReadOptions makeWriteOptions onUnknownField readMessage writeMessage writeUnknownFields

Methods

discardUnknownFields

  • Discard unknown fields for the given message.

    Parameters

    Returns void

listUnknownFields

  • Retrieve the unknown fields for the given message.

    Unknown fields are well-formed protocol buffer serialized data for fields that the parserdoes not recognize.

    For more details see https://developers.google.com/protocol-buffers/docs/proto3#unknowns

    Parameters

    Returns readonly {
        data: Uint8Array;
        no: number;
        wireType: WireType;
    }[]

makeReadOptions

  • Provide options for parsing binary data.

    Parameters

    Returns Readonly<BinaryReadOptions>

makeWriteOptions

  • Provide options for serializing binary data.

    Parameters

    Returns Readonly<BinaryWriteOptions>

onUnknownField

  • Store an unknown field for the given message. The parser will use this method if it does not recognize a field, unless the option readUnknownFields has been disabled.

    Parameters

    Returns void

readMessage

  • Parse a message from binary data, merging fields.

    Parameters

    Returns void

writeMessage

  • Serialize a message to binary data.

    Parameters

    Returns void

writeUnknownFields

  • Retrieve the unknown fields for the given message and write them to the given writer. This method is called when a message is serialized, so the fields that are unknown to the parser persist through a round trip.

    Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc