SyncProtobuf.Reader Struct Reference

The ISyncManager implementation that reads the Protocol Buffers wire format (see SyncProtobuf). Because fields are keyed by integer ID, this reader supports reordering (SupportsReordering) and skips unknown fields. Call Read{T}(ReadOnlyMemory{byte}, SyncObjectFunc{Reader, T}, Options?) to deserialize, or NewReader(ReadOnlyMemory{byte}, Options?) to construct one directly. More...

---

Source file:

• /Core/Loyc.SyncLib.SyncProtobuf/SyncProtobuf.Reader.cs

Inheritance diagram for SyncProtobuf.Reader:

Remarks

The ISyncManager implementation that reads the Protocol Buffers wire format (see SyncProtobuf). Because fields are keyed by integer ID, this reader supports reordering (SupportsReordering) and skips unknown fields. Call Read{T}(ReadOnlyMemory{byte}, SyncObjectFunc{Reader, T}, Options?) to deserialize, or NewReader(ReadOnlyMemory{byte}, Options?) to construct one directly.

This is a struct (for performance) that wraps a mutable state class. Do not use default(Reader); it will throw NullReferenceException.

Public fields
SyncMode	Mode => SyncMode.Reading
bool	IsReading => true
bool	IsWriting => false
bool	SupportsReordering => true
bool	SupportsDeduplication => true
bool	NeedsIntegerIds => true
bool	SupportsNextField => true
bool	IsPlainText => false
ISyncOptions	Options => _s._opt
bool	IsInsideList => _s.IsInsideList
bool	ReachedEndOfList => _s.ReachedEndOfList
int	MinimumListLength => _s.MinimumListLength
int	Depth => _s.Depth
FieldId	NextField => _s.NextField
bool	Begun
bool int	Length

Properties
object	CurrentObject [set]

Public Member Functions
SyncType	GetFieldType (FieldId name, SyncType expectedType=SyncType.Unknown)
string	SyncTypeTag (string?tag)
bool	Sync (FieldId name, bool savable)
sbyte	Sync (FieldId name, sbyte savable)
byte	Sync (FieldId name, byte savable)
short	Sync (FieldId name, short savable)
ushort	Sync (FieldId name, ushort savable)
int	Sync (FieldId name, int savable)
uint	Sync (FieldId name, uint savable)
long	Sync (FieldId name, long savable)
ulong	Sync (FieldId name, ulong savable)
float	Sync (FieldId name, float savable)
double	Sync (FieldId name, double savable)
decimal	Sync (FieldId name, decimal savable)
BigInteger	Sync (FieldId name, BigInteger savable)
char	Sync (FieldId name, char savable)
string	Sync (FieldId name, string?savable, ObjectMode mode=ObjectMode.Normal)
int	Sync (FieldId name, int savable, int bits, bool signed=true)
long	Sync (FieldId name, long savable, int bits, bool signed=true)
BigInteger	Sync (FieldId name, BigInteger savable, int bits, bool signed=true)
bool	Sync (FieldId name, bool?savable)
sbyte	Sync (FieldId name, sbyte?savable)
byte	Sync (FieldId name, byte?savable)
short	Sync (FieldId name, short?savable)
ushort	Sync (FieldId name, ushort?savable)
int	Sync (FieldId name, int?savable)
uint	Sync (FieldId name, uint?savable)
long	Sync (FieldId name, long?savable)
ulong	Sync (FieldId name, ulong?savable)
float	Sync (FieldId name, float?savable)
double	Sync (FieldId name, double?savable)
decimal	Sync (FieldId name, decimal?savable)
BigInteger	Sync (FieldId name, BigInteger?savable)
char	Sync (FieldId name, char?savable)
List	SyncListBoolImpl< Scanner, List, ListBuilder > (FieldId name, Scanner scanner, List?saving, ListBuilder builder, ObjectMode mode, int tupleLength=-1)
List	SyncListByteImpl< Scanner, List, ListBuilder > (FieldId name, Scanner scanner, List?saving, ListBuilder builder, ObjectMode mode, int tupleLength=-1)
List	SyncListCharImpl< Scanner, List, ListBuilder > (FieldId name, Scanner scanner, List?saving, ListBuilder builder, ObjectMode mode, int tupleLength=-1)
bool int object Object	BeginSubObject (FieldId name, object?childKey, ObjectMode mode, int listLength=-1)
void	EndSubObject ()