packet/packet_transformer library

Classes

Bool
Represents a native bool in C.
ByteField<V extends NativeType>
ByteField - a Typed Offset into a ByteStruct and TypedData. Defines a field of a ByteStruct by its offset and type.
ByteStructBase<S extends ByteStructBase<S, K>, K extends ByteField<NativeType>>
ByteStructBase — abstract base for user-defined byte struct subtypes.
ByteStructBuffer<T>
buffer type for partial view
Double
Represents a native 64 bit double in C.
Float
Represents a native 32 bit float in C.
HeaderParser
Packet Rx Meta Parser Buffer Rx Packet Buffer and the state of the PacketTransformer
HeaderStatus
immutable view of packet parsing status determine complete, error, or wait for more data as state machine state
Int
The C int type.
Int16
Represents a native signed 16 bit integer in C.
Int32
Represents a native signed 32 bit integer in C.
Int64
Represents a native signed 64 bit integer in C.
Int8
Represents a native signed 8 bit integer in C.
NativeType
NativeType's subtypes represent a native type in C.
Packet
Packet as interface for immutable view of varying view length.
PacketBuffer<T extends Packet>
/////////////////////////////////////////////////////////////////////////
PacketFormat<T extends Packet>
Collective def of Packet format. Descriptor/'Class variables'
PacketId
PacketIdCaster
///////////////////////////////////////////////////////////////////////// PacketId Types ///////////////////////////////////////////////////////////////////////// build idOf from lists internally PacketIdFactory
PacketIdRequest<T, R>
Id as payload factory A Request matched with a Response paired request response id for simplicity in case of shared id by request and response can under define responseId for 1-way handlers as constructors, const for enum
PacketPayloadId<V>
PacketStatus
PacketSyncId
PacketTransformer
combine partial/fragmented packets emitted Packet is a reference to the buffer, not a copy. handling must be synchronous, before returning control to the transformer
Payload<V>
Payload<V>
PayloadMeta
any additional state not included in the header
TypedDataBuffer
TypedDataBuffer - BytesBuilderBuffer effectively, a fixed size BytesBuilder - allocated with a persistent buffer
TypedField<T extends NativeType>
StructField/NativeKey/StructKey, Typed 0,1,2,4,8 bytes
Uint16
Represents a native unsigned 16 bit integer in C.
Uint32
Represents a native unsigned 32 bit integer in C.
Uint64
Represents a native unsigned 64 bit integer in C.
Uint8
Represents a native unsigned 8 bit integer in C.

Extension Types

ByteForm
ByteStruct
ByteStruct is a TypedData with keyed/named access to fields. TypedData + [] Map operators returning int keyed view mixin keyed access for serialization map

Extensions

ByteDataArrayAccess on ByteData
ByteDataWordAccess on ByteData
PacketFormatTransformer on PacketFormat<Packet>
PacketIdMethods on PacketId
TypedDataCast on TypedData
sublistView using length instead of end Effectively moving up ByteBuffer layer, to TypedData view segment accounting for this.offsetInBytes
TypedDataLength on TypedData
implementations on TypedData returning as this type parameters in element size of this type
TypedDataListSeek on T
TypedList version of List<int>.skip
TypedDataSlices on T
Slices returning TypedData Slices on List cannot return TypedData

Functions

bytesPerElementOf<T extends TypedData>() → int
fromListInt<T extends TypedDataList<int>>(List<int> elements) → T
sublistView<T extends TypedData>(TypedData data, [int start = 0, int? end]) → T
GenericSublistView offset in elements, type of data, not T type.
typedList<T extends TypedDataList>(int length) → T
Wrappers as top level functions

Typedefs

PacketCaster<P extends Packet> = P Function(TypedData typedData)
PayloadCaster<V> = Payload<V> Function(TypedData typedData)
Payload Constructor - handler per id Struct.create<T>
TypedDataCaster<T> = T Function(TypedData typedData)
T is ByteStruct or ffi.Struct