FieldSerializable class abstract

Interface for other field-level annotations. For example, class Rest extends FieldSerializable {}

Constructors

FieldSerializable()

Properties

defaultValue → String?
The value to use if the source's value is null. This is often directly injected to the adapter, and wrapping is required for strings. (e.g. defaultValue: "'Missing Last Name'")
no setter
enumAsString → bool
By default, all enums are assumed to be delivered as int. However, this requires order to be maintained; additionally some providers deliver enums as String (e.g. {"party", "baseball", ...}). This field value should apply to Iterable and single field types of enum.
no setter
fromGenerator → String?
Manipulates output for the field in the deserialize generator. The instance's field name is automatically defined. While the build method is ultimately responsible for how the output is applied, it is most often directly injected as the value of the field in the deserialize adapter.
no setter
hashCode → int
The hash code for this object.
no setterinherited
ignore → bool
true if the generator should ignore this field completely. When true, takes precedence over ignoreFrom and ignoreTo. Defaults to false.
no setter
ignoreFrom → bool
true if this field should be ignored only during deserializization (when remote data is converted to Dart code). Defaults to false.
no setter
ignoreTo → bool
true if this field should be ignored only during serializization (when Dart code is sent to a remote source). Defaults to false.
no setter
name → String?
The key name to use when reading and writing values corresponding to the annotated field.
no setter
nullable → bool
When true, null fields are handled gracefully when serializing and deserializing. For Dart >=2.12, the member type must also be nullable (i.e. bool?).
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
toGenerator → String?
Manipulates output for the field in the serialize generator. The serializing key is defined from name or the default naming of the field. While the build method is ultimately responsible for how the output is applied, it is most often directly injected as the value of the field in the serialize adapter.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

ANNOTATED_NAME_VARIABLE → const String
Placeholder. Replaces with name (e.g. @Rest(name:) or @Sqlite(name:)). Defaults to field name after any applicable renaming transforms.
DATA_PROPERTY_VARIABLE → const String
Placeholder. Replaces with data['annotated_name'] per @Rest(name:) or @Sqlite(name:). Only valuable for from generators.
INSTANCE_PROPERTY_VARIABLE → const String
Placeholder. Replaces with field name (instance.myField in final String myField). Only valuable for to generators.