IProtoConverter

Description

interface Tinman.Core.IO.Serialization.IProtoConverter → <T>

Base interface for classes that convert between atomic values and the Protocol Buffers wire format.

Public / Methods

ProtoReadChecked

public method ProtoReadChecked → (2)

record ⁱⁿ : Record: The record in the wire stream of type Wire.LEN to use for reading a value.
hasValue ^out : bool: true if a value has been read from record ⁱⁿ,
false if no value has been read.
returns → T: The read value.

Reads a value from the given Protocol Buffers wire format stream.

The calling code is aware of the message type and calls this method on the message record (see IProtonizer.ReadRecord) that fully contains the encoded value.

IOException: If an I/O error has occurred.

See also: IProtoConverter.ProtoRead

ProtoWrite

public method ProtoWrite → (2)

record ⁱⁿ : Record: The record in the wire stream of type Wire.LEN to use for writing the given value ⁱⁿ.
value ⁱⁿ : T: The value to write.

Writes the given value to a Protocol Buffers wire format stream.

The calling code is aware of the message type and thus chooses the field number. This method is responsible for writing the content of a single message record.

IOException: If an I/O error has occurred.

Extensions

ProtoRead

public static method ProtoRead → (2) → <T>

record ⁱⁿ : Record: The record in the wire stream of type Wire.LEN to use for reading a value.
defaultValue ^opt : T = default(T): The default value to use if the record ⁱⁿ does not contain a value. false if the record is empty.
returns → T: The read value.