serde library

SerDe annotations for Dust JSON generation.

Classes

BoolList
A space-efficient list of boolean values.
CanonicalizedMap<C, K, V>
A map whose keys are converted to canonical values of type C.
CaseInsensitiveEquality
String equality that's insensitive to differences in ASCII case.
CombinedIterableView<T>
A view of several iterables combined sequentially into a single iterable.
CombinedListView<T>
A view of several lists combined into a single list.
CombinedMapView<K, V>
Returns a new map that represents maps flattened into a single map.
CopyWith
Generates typed copyWith support.
Debug
Deprecated alias for ToString().
DeepCollectionEquality
Deep equality on collections.
DefaultEquality<E>
Equality of objects that compares only the natural equality of the objects.
DelegatingIterable<E>
An Iterable that delegates all operations to a base iterable.
DelegatingList<E>
A List that delegates all operations to a base list.
DelegatingMap<K, V>
A Map that delegates all operations to a base map.
DelegatingQueue<E>
A Queue that delegates all operations to a base queue.
DelegatingSet<E>
A Set that delegates all operations to a base set.
Derive
Declares which traits Dust should generate for the annotated declaration.
DeriveConfig
Base marker for derive configuration annotations.
DeriveMeta
Base marker for all Dust derive annotations.
DeriveTrait
Base marker for derive traits listed inside @Derive([...]).
Deserialize
Generates _$TypeDeserialize(...) and _$TypeFromJson(...) support.
Deserializer<DartT, JsonT>
Directional conversion contract for generated and custom deserializers.
Eq
Generates value equality through operator == and matching hashCode.
Equality<E>
A generic equality relation on objects.
EqualityBy<E, F>
Equality of objects based on derived values.
EqualityMap<K, V>
A Map whose key equality is determined by an Equality object.
EqualitySet<E>
A Set whose key equality is determined by an Equality object.
Err<T, E>
Failed operation result.
HeapPriorityQueue<E>
Heap based priority queue.
IdentityEquality<E>
Equality of objects that compares only the identity of the objects.
Invalid
Failed validation result.
IterableEquality<E>
Equality on iterables.
IterableZip<T>
Iterable that iterates over lists of values from other iterables.
JsonHelper
Shared runtime helpers used by Dust-generated serde code.
Length
Type-safe length validator configuration.
ListEquality<E>
Equality on lists.
ListSlice<E>
A list view of a range of another list.
MapEquality<K, V>
Equality on maps.
MapKeySet<E>
An unmodifiable Set view of the keys of a Map.
MapValueSet<K, V>
Creates a modifiable Set view of the values of a Map.
MultiEquality<E>
Combines several equalities into a single equality.
None<T>
Option state for an absent value.
NonGrowableListMixin<E>
Mixin class that implements a throwing version of all list operations that change the List's length.
NonGrowableListView<E>
A fixed-length list.
Ok<T, E>
Successful operation result.
Option<T>
Optional value wrapper for Rust-style present-or-absent values.
PriorityQueue<E>
A priority queue is a priority based work-list of elements.
QueueList<E>
A class that efficiently implements both Queue and List.
Range
Type-safe numeric range validator configuration.
Result<T, E>
Result of an operation that can either succeed with T or fail with E.
SerDe
Configures how Dust generates or interprets serde metadata.
SerDeCodec<DartT, JsonT>
Field-level conversion contract for custom Dust serde handling.
Serializable
Instance contract generated for classes deriving Serialize.
Serialize
Generates serialize() and toJson() support for the annotated class or enum.
Serializer<DartT, JsonT>
Directional conversion contract for generated and custom serializers.
SetEquality<E>
Equality of sets.
Some<T>
Option state for a present value.
ToString
Generates a toString() implementation from the class fields.
UnionSet<E>
A single set that provides a view of the union over a set of sets.
UnionSetController<E>
A controller that exposes a view of the union of a collection of sets.
Unit
Empty success value for operations that only signal completion.
UnmodifiableListView<E>
An unmodifiable List view of another List.
UnmodifiableMapMixin<K, V>
Mixin class that implements a throwing version of all map operations that change the Map.
UnmodifiableMapView<K, V>
View of a Map that disallow modifying the map.
UnmodifiableSetMixin<E>
Mixin class that implements a throwing version of all set operations that change the Set.
UnmodifiableSetView<E>
An unmodifiable set.
UnorderedIterableEquality<E>
Equality of the elements of two iterables without considering order.
Valid
Successful validation result.
Validatable
Runtime contract implemented by generated Validate() mixins.
Validate<T>
Generates validation methods and configures field validators.
ValidationError
One validation failure.
ValidationHelper
Shared helpers used by generated validation code.
ValidationResult
Result returned by generated validation.

Enums

SerDeRename
The rename strategy used when Dust derives JSON keys automatically.

Extensions

ComparatorExtension on Comparator<T>
Extensions on comparator functions.
DeserializerJsonMirror on Deserializer<DartT, JsonT>
Dart ecosystem mirrors for deserializers.
IterableComparableExtension on Iterable<T>
Extensions that apply to iterables of Comparable elements.
IterableDoubleExtension on Iterable<double>
Extension on iterables of double.
IterableExtension on Iterable<T>
Extensions that apply to all iterables.
IterableIntegerExtension on Iterable<int>
Extension on iterables of integers.
IterableIterableExtension on Iterable<Iterable<T>>
Extensions on iterables whose elements are also iterables.
IterableNullableExtension on Iterable<T?>
Extensions that apply to iterables with a nullable element type.
IterableNumberExtension on Iterable<num>
Extensions that apply to iterables of numbers.
ListComparableExtensions on List<E>
Various extensions on lists of comparable elements.
ListExtensions on List<E>
Various extensions on lists of arbitrary elements.
SerializerJsonMirror on Serializer<DartT, JsonT>
Dart ecosystem mirrors for serializers.

Constants

unit → const Unit
Shared unit value.

Functions

binarySearch<E>(List<E> sortedList, E value, {int compare(E, E)?}) → int
Returns a position of the value in sortedList, if it is there.
compareAsciiLowerCase(String a, String b) → int
Compares a and b lexically, converting ASCII letters to lower case.
compareAsciiLowerCaseNatural(String a, String b) → int
Compares strings a and b according to lower-case natural sort ordering.
compareAsciiUpperCase(String a, String b) → int
Compares a and b lexically, converting ASCII letters to upper case.
compareAsciiUpperCaseNatural(String a, String b) → int
Compares strings a and b according to upper-case natural sort ordering.
compareNatural(String a, String b) → int
Compares strings a and b according to natural sort ordering.
equalsIgnoreAsciiCase(String a, String b) → bool
Checks if strings a and b differ only on the case of ASCII letters.
groupBy<S, T>(Iterable<S> values, T key(S)) → Map<T, List<S>>
Groups the elements in values by the value returned by key.
hashIgnoreAsciiCase(String string) → int
Hash code for a string which is compatible with equalsIgnoreAsciiCase.
insertionSort<E>(List<E> elements, {int compare(E, E)?, int start = 0, int? end}) → void
Sort a list between start (inclusive) and end (exclusive) using insertion sort.
lastBy<S, T>(Iterable<S> values, T key(S)) → Map<T, S>
Associates the elements in values by the value returned by key.
lowerBound<E>(List<E> sortedList, E value, {int compare(E, E)?}) → int
Returns the first position in sortedList that does not compare less than value.
mapMap<K1, V1, K2, V2>(Map<K1, V1> map, {K2 key(K1, V1)?, V2 value(K1, V1)?}) → Map<K2, V2>
Creates a new map from map with new keys and values.
maxBy<S, T>(Iterable<S> values, T orderBy(S), {int compare(T, T)?}) → S?
Returns the element of values for which orderBy returns the maximum value.
mergeMaps<K, V>(Map<K, V> map1, Map<K, V> map2, {V value(V, V)?}) → Map<K, V>
Returns a new map with all key/value pairs in both map1 and map2.
mergeSort<E>(List<E> elements, {int start = 0, int? end, int compare(E, E)?}) → void
Sorts a list between start (inclusive) and end (exclusive) using the merge sort algorithm.
minBy<S, T>(Iterable<S> values, T orderBy(S), {int compare(T, T)?}) → S?
Returns the element of values for which orderBy returns the minimum value.
reverse<E>(List<E> elements, [int start = 0, int? end]) → void
Reverses a list, or a part of a list, in-place.
shuffle(List elements, [int start = 0, int? end, Random? random]) → void
Shuffles a list randomly.
stronglyConnectedComponents<T>(Map<T, Iterable<T>> graph) → List<Set<T>>
Returns the strongly connected components of graph, in topological order.
transitiveClosure<T>(Map<T, Iterable<T>> graph) → Map<T, Set<T>>
Returns the transitive closure of graph.

Typedefs

FieldValidator<T> = ValidationError? Function(T value)
Custom validator callback used by field-level @Validate(custom: ...).

Exceptions / Errors

ValidationException
Exception thrown by generated validateOrThrow().