Class MessageParser (3.15.8)

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

MessageParser<T>

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

Name	Description
input	Stream The stream to parse.

Returns

Type	Description
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

Name	Description
data	ByteString The data to parse.

Returns

Type	Description
IMessage	The parsed message.

ParseFrom(CodedInputStream)

public IMessage ParseFrom(CodedInputStream input)

Parses a message from the given coded input stream.

Parameter

Name	Description
input	CodedInputStream The stream to parse.

Returns

Type	Description
IMessage	The parsed message.

ParseFrom(ReadOnlySequence<Byte>)

public IMessage ParseFrom(ReadOnlySequence<byte> data)

Parses a message from the given sequence.

Parameter

Name	Description
data	ReadOnlySequence<Byte> The data to parse.

Returns

Type	Description
IMessage	The parsed message.

ParseFrom(Stream)

public IMessage ParseFrom(Stream input)

Parses a message from the given stream.

Parameter

Name	Description
input	Stream The stream to parse.

Returns

Type	Description
IMessage	The parsed message.

ParseFrom(Byte[])

public IMessage ParseFrom(byte[] data)

Parses a message from a byte array.

Parameter

Name	Description
data	Byte[] The byte array containing the message. Must not be null.

Returns

Type	Description
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

Name	Description
data	Byte[] The byte array containing the message. Must not be null.
offset	Int32 The offset of the slice to parse.
length	Int32 The length of the slice to parse.

Returns

Type	Description
IMessage	The newly parsed message.

ParseJson(String)

public IMessage ParseJson(string json)

Parses a message from the given JSON.

Parameter

Name	Description
json	String The JSON to parse.

Returns

Type	Description
IMessage	The parsed message.

Exceptions

Type	Description
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

Name	Description
discardUnknownFields	Boolean Whether or not to discard unknown fields when parsing.

Returns

Type	Description
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

Name	Description
registry	ExtensionRegistry The extensions to register

Returns

Type	Description
MessageParser	A newly configured message parser.