Record

Description

struct Tinman.Core.IO.Serialization.Record

Helper class for using the Protocol Buffers wire format for serialization.

See also: IProtonizer.ReadRecord
IProtonizer.WriteRecord

Public / Constants

None

public static readonly attribute None → (Record)

Special Record value that indicates a non-existent record.

Public / Constructors

Read

public static method Read → (1)

wire ⁱⁿ : IByteReader: [not-null]
The input stream.
returns → Record: The Record to use for reading the payload.

Begins to read a record from the given Protocol Buffers wire format stream.

IOException: If an I/O error has occurred.

Write

public static method Write → (3)

wire ⁱⁿ : IByteWriter: [not-null]
The output stream.
field ⁱⁿ : int32: The field number.
type ⁱⁿ : Wire: The wire type.
returns → Record: The Record to use for writing the payload.

Begins to write a record to the given Protocol Buffers wire format stream.

IOException: If an I/O error has occurred.

Public / Methods

Read_bool_1

public method Read_bool_1 → (1)

current ^opt : bool = false: The current value.
returns → bool: The read value.

Reads a single bool field value (Wire.VARINT) or the last one of a packed repeated field (Wire.LEN).

IOException: If an I/O error has occurred.

Read_bool_N

_2 overloads

public method Read_bool_N¹ → (1)

output ⁱⁿ : ICollector<bool>: [not-null]
The value output.

Reads a single bool field value (Wire.VARINT) or all packed repeated field values (Wire.LEN).

IOException: If an I/O error has occurred.

public method Read_bool_N² → (1)

output ⁱⁿ : ArrayVector<bool>: The value output or null.
returns → ArrayVector<bool>: The value output.

Reads a single bool field value (Wire.VARINT) or all packed repeated field values (Wire.LEN).

IOException: If an I/O error has occurred.

Read_bytes

public method Read_bytes → ()

returns → int8 [ ]: The read value.

Reads a single bytes field value (Wire.LEN).

IOException: If an I/O error has occurred.

Read_double_1

public method Read_double_1 → (1)

current ^opt : float64 = 0: The current value.
returns → float64: The read value.

Reads a single double field value (Wire.I64) or the last one of a packed repeated field (Wire.LEN).

IOException: If an I/O error has occurred.

Read_double_N

_2 overloads

public method Read_double_N¹ → (1)

output ⁱⁿ : ICollector<float64>: [not-null]
The value output.

Reads a single double field value (Wire.I64) or all packed repeated field values (Wire.LEN).

IOException: If an I/O error has occurred.

public method Read_double_N² → (1)

output ⁱⁿ : ArrayVector<float64>: The value output or null.
returns → ArrayVector<float64>: The value output.

Reads a single double field value (Wire.I64) or all packed repeated field values (Wire.LEN).

IOException: If an I/O error has occurred.

Read_enum_1

public method Read_enum_1 → (1)
→ <T ^val : Enum>

current ⁱⁿ : T: The current value.
returns → T: The read value.

Reads a single enum field value (Wire.VARINT) or the last one of a packed repeated field (Wire.LEN).

IOException: If an I/O error has occurred.

Read_enum_N

_2 overloads

public method Read_enum_N¹ → (1)
→ <T ^val : Enum>

output ⁱⁿ : ICollector<T>: [not-null]
The value output.

Reads a single enum field value (Wire.VARINT) or all packed repeated field values (Wire.LEN).

IOException: If an I/O error has occurred.

public method Read_enum_N² → (1)
→ <T ^val : Enum>

output ⁱⁿ : ArrayVector<T>: The value output or null.
returns → ArrayVector<T>: The value output.

Reads a single enum field value (Wire.VARINT) or all packed repeated field values (Wire.LEN).

IOException: If an I/O error has occurred.

Read_fixed32_1

public method Read_fixed32_1 → (1)

current ^opt : int32 = 0: The current value.
returns → int32: The read value.

Reads a single fixed32, sfixed32 field value (Wire.I32) or the last one of a packed repeated field (Wire.LEN).

IOException: If an I/O error has occurred.

Read_fixed32_N

_2 overloads

public method Read_fixed32_N¹ → (1)

output ⁱⁿ : ICollector<int32>: [not-null]
The value output.

Reads a single fixed32, sfixed32 field value (Wire.I32) or all packed repeated field values (Wire.LEN).

IOException: If an I/O error has occurred.

public method Read_fixed32_N² → (1)

output ⁱⁿ : ArrayVector<int32>: The value output or null.
returns → ArrayVector<int32>: The value output.

Reads a single fixed32, sfixed32 field value (Wire.I32) or all packed repeated field values (Wire.LEN).

IOException: If an I/O error has occurred.

Read_fixed64_1

public method Read_fixed64_1 → (1)

current ^opt : int64 = 0: The current value.
returns → int64: The read value.

Reads a single fixed64, sfixed64 field value (Wire.I64) or the last one of a packed repeated field (Wire.LEN).

IOException: If an I/O error has occurred.

Read_fixed64_N

_2 overloads

public method Read_fixed64_N¹ → (1)

output ⁱⁿ : ICollector<int64>: [not-null]
The value output.

Reads a single fixed64, sfixed64 field value (Wire.I64) or all packed repeated field values (Wire.LEN).

IOException: If an I/O error has occurred.

public method Read_fixed64_N² → (1)

output ⁱⁿ : ArrayVector<int64>: The value output or null.
returns → ArrayVector<int64>: The value output.

Reads a single fixed64, sfixed64 field value (Wire.I64) or all packed repeated field values (Wire.LEN).

IOException: If an I/O error has occurred.

Read_float_1

public method Read_float_1 → (1)

current ^opt : float32 = 0: The current value.
returns → float32: The read value.

Reads a single float field value (Wire.I32) or the last one of a packed repeated field (Wire.LEN).

IOException: If an I/O error has occurred.

Read_float_N

_2 overloads

public method Read_float_N¹ → (1)

output ⁱⁿ : ICollector<float32>: [not-null]
The value output.

Reads a single float field value (Wire.I32) or all packed repeated field values (Wire.LEN).

IOException: If an I/O error has occurred.

public method Read_float_N² → (1)

output ⁱⁿ : ArrayVector<float32>: The value output or null.
returns → ArrayVector<float32>: The value output.

Reads a single float field value (Wire.I32) or all packed repeated field values (Wire.LEN).

IOException: If an I/O error has occurred.

Read_length

public method Read_length → ()

returns → int32: The read value.

Reads a length value (Wire.LEN).

IOException: If an I/O error has occurred.

Read_object

_3 overloads

public method Read_object¹ → (2)
→ <T ^ref : IProtonizable>

wire ⁱⁿ : IProtonizer: [not-null]
The wire format stream.
current ⁱⁿ : T: The output object or null to create a new one.
returns → T: The read value.

Reads a single embedded message field value (Wire.LEN).

IOException: If an I/O error has occurred.

public method Read_object² → (3)
→ <T ^ref : IProtonizable>

wire ⁱⁿ : IProtonizer: [not-null]
The wire format stream.
output ⁱⁿ : ICollector<T>: [not-null]
The value output.
current ^opt : IProtonizable = null: The output object or null to create a new one.

Reads a single embedded message field value (Wire.LEN).

IOException: If an I/O error has occurred.

public method Read_object³ → (3)
→ <T ^ref : IProtonizable>

wire ⁱⁿ : IProtonizer: [not-null]
The wire format stream.
output ⁱⁿ : ArrayVector<T>: The value output or null.
current ^opt : IProtonizable = null: The output object or null to create a new one.
returns → ArrayVector<T>: The value output.

Reads a single embedded message field value (Wire.LEN).

IOException: If an I/O error has occurred.

Read_object2

public method Read_object2 → (3)
→ <T ^ref : IProtonizable>

wire ⁱⁿ : IProtonizer: [not-null]
The wire format stream.
output ⁱⁿ : ConsumerDelegate<T>: [not-null]
The value output.
current ⁱⁿ : T: [not-null]
The output object.

Reads a single embedded message field value (Wire.LEN).

This method calls IProtonizable.ProtoDefault on current ⁱⁿ, then delegates to Read_object¹ and finally invokes the given output ⁱⁿ callback, passing current ⁱⁿ.

IOException: If an I/O error has occurred.

Read_sint32_1

public method Read_sint32_1 → (1)

current ^opt : int32 = 0: The current value.
returns → int32: The read value.

Reads a single sint32 field value (Wire.VARINT) or the last one of a packed repeated field (Wire.LEN).

IOException: If an I/O error has occurred.

Read_sint32_N

_2 overloads

public method Read_sint32_N¹ → (1)

output ⁱⁿ : ICollector<int32>: [not-null]
The value output.

Reads a single sint32 field value (Wire.VARINT) or all packed repeated field values (Wire.LEN).

IOException: If an I/O error has occurred.

public method Read_sint32_N² → (1)

output ⁱⁿ : ArrayVector<int32>: The value output or null.
returns → ArrayVector<int32>: The value output.

Reads a single sint32 field value (Wire.VARINT) or all packed repeated field values (Wire.LEN).

IOException: If an I/O error has occurred.

Read_sint64_1

public method Read_sint64_1 → (1)

current ^opt : int64 = 0: The current value.
returns → int64: The read value.

Reads a single sint64 field value (Wire.VARINT) or the last one of a packed repeated field (Wire.LEN).

IOException: If an I/O error has occurred.

Read_sint64_N

_2 overloads

public method Read_sint64_N¹ → (1)

output ⁱⁿ : ICollector<int64>: [not-null]
The value output.

Reads a single sint64 field value (Wire.VARINT) or all packed repeated field values (Wire.LEN).

IOException: If an I/O error has occurred.

public method Read_sint64_N² → (1)

output ⁱⁿ : ArrayVector<int64>: The value output or null.
returns → ArrayVector<int64>: The value output.

Reads a single sint64 field value (Wire.VARINT) or all packed repeated field values (Wire.LEN).

IOException: If an I/O error has occurred.

Read_string

_3 overloads

public method Read_string¹ → ()

returns → string: The read value.

Reads a single string field value (Wire.LEN).

IOException: If an I/O error has occurred.

public method Read_string² → (1)

output ⁱⁿ : ICollector<string>: [not-null]
The value output.

Reads a single string field value (Wire.LEN).

IOException: If an I/O error has occurred.

public method Read_string³ → (1)

output ⁱⁿ : ArrayVector<string>: The value output or null.
returns → ArrayVector<string>: The value output.

Reads a single string field value (Wire.LEN).

IOException: If an I/O error has occurred.

Read_uint32_1

public method Read_uint32_1 → (1)

current ^opt : int32 = 0: The current value.
returns → int32: The read value.

Reads a single int32, uint32, enum field value ( Wire.VARINT) or the last one of a packed repeated field ( Wire.LEN).

IOException: If an I/O error has occurred.

Read_uint32_N

_2 overloads

public method Read_uint32_N¹ → (1)

output ⁱⁿ : ICollector<int32>: [not-null]
The value output.

Reads a single int32, uint32, enum field value ( Wire.VARINT) or all packed repeated field values (Wire.LEN).

IOException: If an I/O error has occurred.

public method Read_uint32_N² → (1)

output ⁱⁿ : ArrayVector<int32>: The value output or null.
returns → ArrayVector<int32>: The value output.

Reads a single int32, uint32, enum field value ( Wire.VARINT) or all packed repeated field values (Wire.LEN).

IOException: If an I/O error has occurred.

Read_uint64_1

public method Read_uint64_1 → (1)

current ^opt : int64 = 0: The current value.
returns → int64: The read value.

Reads a single int64, uint64 field value (Wire.VARINT) or the last one of a packed repeated field (Wire.LEN).

IOException: If an I/O error has occurred.

Read_uint64_N

_2 overloads

public method Read_uint64_N¹ → (1)

output ⁱⁿ : ICollector<int64>: [not-null]
The value output.

Reads a single int64, uint64 field value (Wire.VARINT) or all packed repeated field values (Wire.LEN).

IOException: If an I/O error has occurred.

public method Read_uint64_N² → (1)

output ⁱⁿ : ArrayVector<int64>: The value output or null.
returns → ArrayVector<int64>: The value output.

Reads a single int64, uint64 field value (Wire.VARINT) or all packed repeated field values (Wire.LEN).

IOException: If an I/O error has occurred.

Skip

public method Skip → ()

Skips the payload of this record.

IOException: If an I/O error has occurred.

Write_bool_1

public method Write_bool_1 → (1)

value ⁱⁿ : bool: The value to write.

Writes a single bool field value (Wire.VARINT).

IOException: If an I/O error has occurred.

Write_bool_N

_2 overloads

public method Write_bool_N¹ → (1)

values ⁱⁿ : IArrayVector<bool>: [not-null]
The values to write.

Writes packed repeated bool field values (Wire.LEN).

IOException: If an I/O error has occurred.

public method Write_bool_N² → (3)

values ⁱⁿ : bool [ ]: [not-null]
The values to write.
first ⁱⁿ : int32: [0..values.Length]
Index of first value to write.
count ⁱⁿ : int32: [0..values.Length-first]
The number of values to write.

Writes packed repeated bool field values (Wire.LEN).

IOException: If an I/O error has occurred.

Write_bytes

public method Write_bytes → (1)

value ⁱⁿ : int8 [ ]: [not-null]
The array that holds the values to write.

Writes a single bytes field value (Wire.LEN).

IOException: If an I/O error has occurred.

Write_double_1

public method Write_double_1 → (1)

value ⁱⁿ : float64: The value to write.

Writes a single double field value (Wire.I64).

IOException: If an I/O error has occurred.

Write_double_N

_2 overloads

public method Write_double_N¹ → (1)

values ⁱⁿ : IArrayVector<float64>: [not-null]
The values to write.

Writes packed repeated double field values (Wire.LEN).

IOException: If an I/O error has occurred.

public method Write_double_N² → (3)

values ⁱⁿ : float64 [ ]: [not-null]
The values to write.
first ⁱⁿ : int32: [0..values.Length]
Index of first value to write.
count ⁱⁿ : int32: [0..values.Length-first]
The number of values to write.

Writes packed repeated double field values (Wire.LEN).

IOException: If an I/O error has occurred.

Write_enum_1

public method Write_enum_1 → (1)
→ <T ^val : Enum>

value ⁱⁿ : T: The value to write.

Writes a single enum field value (Wire.VARINT).

IOException: If an I/O error has occurred.

Write_enum_N

_2 overloads

public method Write_enum_N¹ → (1)
→ <T ^val : Enum>

values ⁱⁿ : IArrayVector<T>: [not-null]
The values to write.

Writes packed repeated enum field values (Wire.LEN).

IOException: If an I/O error has occurred.

public method Write_enum_N² → (3)
→ <T ^val : Enum>

values ⁱⁿ : T [ ]: [not-null]
The values to write.
first ⁱⁿ : int32: [0..values.Length]
Index of first value to write.
count ⁱⁿ : int32: [0..values.Length-first]
The number of values to write.

Writes packed repeated enum field values (Wire.LEN).

IOException: If an I/O error has occurred.

Write_fixed32_1

public method Write_fixed32_1 → (1)

value ⁱⁿ : int32: The value to write.

Writes a single fixed32, sfixed32 field value (Wire.I32).

IOException: If an I/O error has occurred.

Write_fixed32_N

_2 overloads

public method Write_fixed32_N¹ → (1)

values ⁱⁿ : IArrayVector<int32>: [not-null]
The values to write.

Writes packed repeated fixed32, sfixed32 field values ( Wire.LEN).

IOException: If an I/O error has occurred.

public method Write_fixed32_N² → (3)

values ⁱⁿ : int32 [ ]: [not-null]
The values to write.
first ⁱⁿ : int32: [0..values.Length]
Index of first value to write.
count ⁱⁿ : int32: [0..values.Length-first]
The number of values to write.

Writes packed repeated fixed32, sfixed32 field values ( Wire.LEN).

IOException: If an I/O error has occurred.

Write_fixed64_1

public method Write_fixed64_1 → (1)

value ⁱⁿ : int64: The value to write.

Writes a single fixed64, sfixed64 field value (Wire.I64).

IOException: If an I/O error has occurred.

Write_fixed64_N

_2 overloads

public method Write_fixed64_N¹ → (1)

values ⁱⁿ : IArrayVector<int64>: [not-null]
The values to write.

Writes packed repeated fixed64, sfixed64 field values ( Wire.LEN).

IOException: If an I/O error has occurred.

public method Write_fixed64_N² → (3)

values ⁱⁿ : int64 [ ]: [not-null]
The values to write.
first ⁱⁿ : int32: [0..values.Length]
Index of first value to write.
count ⁱⁿ : int32: [0..values.Length-first]
The number of values to write.

Writes packed repeated fixed64, sfixed64 field values ( Wire.LEN).

IOException: If an I/O error has occurred.

Write_float_1

public method Write_float_1 → (1)

value ⁱⁿ : float32: The value to write.

Writes a single float field value (Wire.I32)

IOException: If an I/O error has occurred.

Write_float_N

_2 overloads

public method Write_float_N¹ → (1)

values ⁱⁿ : IArrayVector<float32>: [not-null]
The values to write.

Writes packed repeated float field values (Wire.LEN).

IOException: If an I/O error has occurred.

public method Write_float_N² → (3)

values ⁱⁿ : float32 [ ]: [not-null]
The values to write.
first ⁱⁿ : int32: [0..values.Length]
Index of first value to write.
count ⁱⁿ : int32: [0..values.Length-first]
The number of values to write.

Writes packed repeated float field values (Wire.LEN).

IOException: If an I/O error has occurred.

Write_length

public method Write_length → (1)

length ⁱⁿ : int32: [>=0]
The value to write.

Writes a length value (Wire.LEN).

IOException: If an I/O error has occurred.

Write_object

public method Write_object → (2)

wire ⁱⁿ : IProtonizer: [not-null]
The wire format stream.
value ⁱⁿ : IProtonizable: [not-null]
The value to write.

Writes a single embedded message field value (Wire.LEN).

IOException: If an I/O error has occurred.

Write_sint32_1

public method Write_sint32_1 → (1)

value ⁱⁿ : int32: The value to write.

Writes a single sint32 field value.

IOException: If an I/O error has occurred.

See also: Wire.VARINT

Write_sint32_N

_2 overloads

public method Write_sint32_N¹ → (1)

values ⁱⁿ : IArrayVector<int32>: [not-null]
The values to write.

Writes packed repeated sint32 field values (Wire.LEN).

IOException: If an I/O error has occurred.

public method Write_sint32_N² → (3)

values ⁱⁿ : int32 [ ]: [not-null]
The values to write.
first ⁱⁿ : int32: [0..values.Length]
Index of first value to write.
count ⁱⁿ : int32: [0..values.Length-first]
The number of values to write.

Writes packed repeated sint32 field values (Wire.LEN).

IOException: If an I/O error has occurred.

Write_sint64_1

public method Write_sint64_1 → (1)

value ⁱⁿ : int64: The value to write.

Writes a single sint64 field value.

IOException: If an I/O error has occurred.

See also: Wire.VARINT

Write_sint64_N

_2 overloads

public method Write_sint64_N¹ → (1)

values ⁱⁿ : IArrayVector<int64>: [not-null]
The values to write.

Writes packed repeated sint32 field values (Wire.LEN).

IOException: If an I/O error has occurred.

public method Write_sint64_N² → (3)

values ⁱⁿ : int64 [ ]: [not-null]
The values to write.
first ⁱⁿ : int32: [0..values.Length]
Index of first value to write.
count ⁱⁿ : int32: [0..values.Length-first]
The number of values to write.

Writes packed repeated sint32 field values (Wire.LEN).

IOException: If an I/O error has occurred.

Write_string

public method Write_string → (1)

value ⁱⁿ : string: The value to write (null is interpreted as the empty string).

Writes a single string field value (Wire.LEN).

IOException: If an I/O error has occurred.

Write_uint32_1

public method Write_uint32_1 → (1)

value ⁱⁿ : int32: The value to write.

Writes a single int32, uint32, enum field value ( Wire.VARINT)

IOException: If an I/O error has occurred.

Write_uint32_N

_2 overloads

public method Write_uint32_N¹ → (1)

values ⁱⁿ : IArrayVector<int32>: [not-null]
The values to write.

Writes packed repeated int32, uint32, enum field values ( Wire.LEN).

IOException: If an I/O error has occurred.

public method Write_uint32_N² → (3)

values ⁱⁿ : int32 [ ]: [not-null]
The values to write.
first ⁱⁿ : int32: [0..values.Length]
Index of first value to write.
count ⁱⁿ : int32: [0..values.Length-first]
The number of values to write.

Writes packed repeated int32, uint32, enum field values ( Wire.LEN).

IOException: If an I/O error has occurred.

Write_uint64_1

public method Write_uint64_1 → (1)

value ⁱⁿ : int64: The value to write.

Writes a single int64, uint64 field value (Wire.VARINT).

IOException: If an I/O error has occurred.

Write_uint64_N

_2 overloads

public method Write_uint64_N¹ → (1)

values ⁱⁿ : IArrayVector<int64>: [not-null]
The values to write.

Writes packed repeated int64, uint64 field values (Wire.LEN).

IOException: If an I/O error has occurred.

public method Write_uint64_N² → (3)

values ⁱⁿ : int64 [ ]: [not-null]
The values to write.
first ⁱⁿ : int32: [0..values.Length]
Index of first value to write.
count ⁱⁿ : int32: [0..values.Length-first]
The number of values to write.

Writes packed repeated int64, uint64 field values (Wire.LEN).

IOException: If an I/O error has occurred.

Public / Attributes

Field

public readonly attribute Field → (int32)

The message field number or 0 for None.

IsNone

public attribute IsNone → (get)

value : bool: true if this is the None value,
false if not.

Is this the special None value?

Type

public readonly attribute Type → (Wire)

The wire type.

Record

Description

Public / Constants

None

Public / Constructors

Read

Write

Public / Methods

Read_bool_1

Read_bool_​N

Read_bytes

Read_double_1

Read_double_​N

Read_enum_1

Read_enum_​N

Read_fixed32_1

Read_fixed32_​N

Read_fixed64_1

Read_fixed64_​N

Read_float_1

Read_float_​N

Read_length

Read_object

Read_object2

Read_sint32_1

Read_sint32_​N

Read_sint64_1

Read_sint64_​N

Read_string

Read_uint32_1

Read_uint32_​N

Read_uint64_1

Read_uint64_​N

Skip

Write_bool_1

Write_bool_​N

Write_bytes

Write_double_1

Write_double_​N

Write_enum_1

Write_enum_​N

Write_fixed32_1

Write_fixed32_​N

Write_fixed64_1

Write_fixed64_​N

Write_float_1

Write_float_​N

Write_length

Write_object

Write_sint32_1

Write_sint32_​N

Write_sint64_1

Write_sint64_​N

Write_string

Write_uint32_1

Write_uint32_​N

Write_uint64_1

Write_uint64_​N

Public / Attributes

Field

Is​None

Tag

Type

Read_bool_N

Read_double_N

Read_enum_N

Read_fixed32_N

Read_fixed64_N

Read_float_N

Read_sint32_N

Read_sint64_N

Read_uint32_N

Read_uint64_N

Write_bool_N

Write_double_N

Write_enum_N

Write_fixed32_N

Write_fixed64_N

Write_float_N

Write_sint32_N

Write_sint64_N

Write_uint32_N

Write_uint64_N

IsNone