fory library

Public API for the Apache Fory Dart xlang runtime.

Most applications only need Fory, Config, ForyStruct, and ForyField. Buffer, WriteContext, ReadContext, and Serializer are advanced APIs used by generated code, custom serializers, and low-level integrations.

Classes

ArrayField
ArrayType
Bfloat16List
Fixed-length contiguous storage for bfloat16 values.
Bfloat16Type
BinaryType
BoolList
Fixed-length contiguous one-byte storage for bool values.
BoolType
Buffer
A reusable byte buffer with explicit reader and writer indices.
Config
Fory instance configuration for the Dart xlang implementation.
DateType
Decimal
Exact decimal value represented as unscaledValue * 10^-scale.
DecimalType
DeclaredType
DurationType
EnumSerializer<T>
Enum-specific serializer base used by generated enum serializers.
Float16List
Fixed-length contiguous storage for binary16 values.
Float16Type
Float32
Single-precision floating-point wrapper used by the xlang type system.
Float32Type
Float64Type
Fory
Root facade for Apache Fory xlang serialization in Dart.
ForyField
Configures serialization for the storage field on which it is declared.
ForyStruct
Configures Fory generation for an ordinary class or mixin, or for target.
ForyUnion
Marks a class as a Fory union type for generated field metadata.
Int16Type
Int32Type
Int64Type
Int8Type
ListField
ListType
LocalDate
Calendar date without time-of-day or time-zone information.
MapField
MapType
ReadContext
Read-side serializer context.
ScalarTypeSpec
Serializer<T>
Advanced extension point for generated and custom serializers.
SetField
SetType
StringType
Timestamp
Timestamp with second and nanosecond precision in UTC.
TimestampType
TypeIds
Cross-language type identifiers for Fory serialization.
TypeSpec
Uint16Type
Uint32Type
Uint64Type
Uint8Type
UnionSerializer<T>
Union-specific serializer base used by custom union serializers.
WriteContext
Write-side serializer context.

Enums

Encoding

Extension Types

Int64
Signed 64-bit integer wrapper used by the xlang type system.
Int64List
Fixed-length contiguous storage for Int64 values on native platforms.
Uint64
Unsigned 64-bit integer wrapper used by the xlang type system.
Uint64List
Fixed-length contiguous storage for Uint64 values on native platforms.

Functions

fromBfloat16Bits(int bits) double
Expands IEEE 754 bfloat16 bits to a Dart double.
fromFloat16Bits(int bits) double
Expands IEEE 754 binary16 bits to a Dart double.
toBfloat16Bits(double value) int
Converts value to IEEE 754 bfloat16 bits.
toFloat16Bits(double value) int
Converts value to IEEE 754 binary16 bits.

Exceptions / Errors

ForyException
Base exception for Apache Fory Dart runtime failures.
InvalidDataException
Exception thrown when serialized data is invalid for the requested read.