public sealed class MessageParser<T> : MessageParser where T : IMessage<T>A parser for a specific message type.
Namespace
Google.ProtobufAssembly
Google.Protobuf.dll
Type Parameter | |
|---|---|
| Name | Description |
T | The type of message to be parsed. |
Remarks
This delegates most behavior to the MergeFrom(CodedInputStream) implementation within the original type, but provides convenient overloads to parse from a variety of sources.
Most applications will never need to create their own instances of this type;
instead, use the static Parser property of a generated message type to obtain a
parser for that type.
Constructors
MessageParser(Func<T>)
public MessageParser(Func<T> factory)Creates a new parser.
| Parameter | |
|---|---|
| Name | Description |
factory | Func<T>Function to invoke when a new, empty message is required. |
The factory method is effectively an optimization over using a generic constraint to require a parameterless constructor: delegates are significantly faster to execute.
Methods
ParseDelimitedFrom(Stream)
public T ParseDelimitedFrom(Stream input)Parses a length-delimited message from the given stream.
| Parameter | |
|---|---|
| Name | Description |
input | StreamThe stream to parse. |
| Returns | |
|---|---|
| Type | Description |
T | The parsed message. |
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 T ParseFrom(ByteString data)Parses a message from the given byte string.
| Parameter | |
|---|---|
| Name | Description |
data | ByteStringThe data to parse. |
| Returns | |
|---|---|
| Type | Description |
T | The parsed message. |
ParseFrom(CodedInputStream)
public T ParseFrom(CodedInputStream input)Parses a message from the given coded input stream.
| Parameter | |
|---|---|
| Name | Description |
input | CodedInputStreamThe stream to parse. |
| Returns | |
|---|---|
| Type | Description |
T | The parsed message. |
ParseFrom(ReadOnlySequence<Byte>)
public T ParseFrom(ReadOnlySequence<byte> data)Parses a message from the given sequence.
| Parameter | |
|---|---|
| Name | Description |
data | ReadOnlySequence<Byte>The data to parse. |
| Returns | |
|---|---|
| Type | Description |
T | The parsed message. |
ParseFrom(Stream)
public T ParseFrom(Stream input)Parses a message from the given stream.
| Parameter | |
|---|---|
| Name | Description |
input | StreamThe stream to parse. |
| Returns | |
|---|---|
| Type | Description |
T | The parsed message. |
ParseFrom(Byte[])
public T 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 |
T | The newly parsed message. |
ParseFrom(Byte[], Int32, Int32)
public T 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 | Int32The offset of the slice to parse. |
length | Int32The length of the slice to parse. |
| Returns | |
|---|---|
| Type | Description |
T | The newly parsed message. |
ParseJson(String)
public T ParseJson(string json)Parses a message from the given JSON.
| Parameter | |
|---|---|
| Name | Description |
json | StringThe JSON to parse. |
| Returns | |
|---|---|
| Type | Description |
T | 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<T> WithDiscardUnknownFields(bool discardUnknownFields)Creates a new message parser which optionally discards unknown fields when parsing.
| Parameter | |
|---|---|
| Name | Description |
discardUnknownFields | BooleanWhether or not to discard unknown fields when parsing. |
| Returns | |
|---|---|
| Type | Description |
MessageParser<T> | A newly configured message parser. |
WithExtensionRegistry(ExtensionRegistry)
public MessageParser<T> WithExtensionRegistry(ExtensionRegistry registry)Creates a new message parser which registers extensions from the specified registry upon creating the message instance
| Parameter | |
|---|---|
| Name | Description |
registry | ExtensionRegistryThe extensions to register |
| Returns | |
|---|---|
| Type | Description |
MessageParser<T> | A newly configured message parser. |