Class MessageParser

public class MessageParser : object

A general message parser, typically used by reflection-based code as all the methods return simple IMessage.

Inheritance

Object > MessageParser

Derived Types

Namespace

Google.Protobuf

Assembly

Google.Protobuf.dll

Methods

ParseDelimitedFrom(Stream)

public IMessage ParseDelimitedFrom(Stream input)

Parses a length-delimited message from the given stream.

Parameter
TypeNameDescription
Streaminput

The stream to parse.

Returns
TypeDescription
IMessage

The parsed message.

Remarks

The stream is expected to contain a length and then the data. Only the amount of data specified by the length will be consumed.

ParseFrom(ByteString)

public IMessage ParseFrom(ByteString data)

Parses a message from the given byte string.

Parameter
TypeNameDescription
ByteStringdata

The data to parse.

Returns
TypeDescription
IMessage

The parsed message.

ParseFrom(CodedInputStream)

public IMessage ParseFrom(CodedInputStream input)

Parses a message from the given coded input stream.

Parameter
TypeNameDescription
CodedInputStreaminput

The stream to parse.

Returns
TypeDescription
IMessage

The parsed message.

ParseFrom(ReadOnlySequence<Byte>)

public IMessage ParseFrom(ReadOnlySequence<byte> data)

Parses a message from the given sequence.

Parameter
TypeNameDescription
ReadOnlySequence<Byte>data

The data to parse.

Returns
TypeDescription
IMessage

The parsed message.

ParseFrom(Stream)

public IMessage ParseFrom(Stream input)

Parses a message from the given stream.

Parameter
TypeNameDescription
Streaminput

The stream to parse.

Returns
TypeDescription
IMessage

The parsed message.

ParseFrom(Byte[])

public IMessage ParseFrom(byte[] data)

Parses a message from a byte array.

Parameter
TypeNameDescription
Byte[]data

The byte array containing the message. Must not be null.

Returns
TypeDescription
IMessage

The newly parsed message.

ParseFrom(Byte[], Int32, Int32)

public IMessage ParseFrom(byte[] data, int offset, int length)

Parses a message from a byte array slice.

Parameters
TypeNameDescription
Byte[]data

The byte array containing the message. Must not be null.

Int32offset

The offset of the slice to parse.

Int32length

The length of the slice to parse.

Returns
TypeDescription
IMessage

The newly parsed message.

ParseJson(String)

public IMessage ParseJson(string json)

Parses a message from the given JSON.

Parameter
TypeNameDescription
Stringjson

The JSON to parse.

Returns
TypeDescription
IMessage

The parsed message.

Exceptions
TypeCondition
InvalidJsonException

The JSON does not comply with RFC 7159

InvalidProtocolBufferException

The JSON does not represent a Protocol Buffers message correctly

WithDiscardUnknownFields(Boolean)

public MessageParser WithDiscardUnknownFields(bool discardUnknownFields)

Creates a new message parser which optionally discards unknown fields when parsing.

Parameter
TypeNameDescription
BooleandiscardUnknownFields

Whether or not to discard unknown fields when parsing.

Returns
TypeDescription
MessageParser

A newly configured message parser.

WithExtensionRegistry(ExtensionRegistry)

public MessageParser WithExtensionRegistry(ExtensionRegistry registry)

Creates a new message parser which registers extensions from the specified registry upon creating the message instance

Parameter
TypeNameDescription
ExtensionRegistryregistry

The extensions to register

Returns
TypeDescription
MessageParser

A newly configured message parser.