RestDeserialize class - generators library

Constructors

RestDeserialize(ClassElement element, RestFields fields, {required String repositoryName}): Generate a function to produce a ClassElement from REST data

Properties

adapterMethod → String: The method as printed by the adapter. Does not include semicolon.
no setterinherited
adapterMethodInputType → String: The expected input type for the adapterMethod
no setterinherited
adapterMethodOutputType → String: The expected output type of the adapterMethod
no setterinherited
className → String: no setterinherited
constructorName → String: Discover factories within the class that rely on the provider. For example factory User.fromRest
no setterinherited
deserializeInputType → String: The Type expected from the provider when deserializing
no setterinherited
doesDeserialize → bool: Whether this generator serializes or deserializes raw input
finalinherited
element → ClassElement: The annotated class
finalinherited
fields → FieldsForClass<Rest>: The sorted fields of the element
finalinherited
fieldsForGenerator → String: Mash the element's fields into a list for serialization or deserialization
no setterinherited
generateSuffix → String: Code to follow after a class has been instantiated. Must end with semicolon.
no setterinherited
hashCode → int: The hash code for this object.
no setterinherited
instanceFieldsAndMethods → List<String>: Any instance fields that should be copied to the adapter. Should terminate in ; if required.
no setter
providerName → String: For example, Rest or Sqlite
finalinherited
repositoryHasBeenForceCast ↔ bool: Avoid linter error on subsequent passes for the repository. For example, if repository has already been casted to ! it should not be recast
getter/setter pairinherited
repositoryName → String: For example, OfflineFirst
finalinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
serializeMethod → String: Discover serializers within the class that rely on the provider. For example toRest() =>
no setterinherited
serializeOutputType → String: The Type expected by the provider when serializing
no setterinherited
serializingFunctionArguments → String: Expected arguments for the serializing/deserializing function. Does not include parentheses.
no setterinherited
serializingFunctionName → String: The generated deserialize function name
no setterinherited
unignoredFields → Iterable<FieldElement>: All fields that are serializable by this generator and are not declared to be ignored by an annotation.
no setterinherited

Methods

addField(FieldElement field, Rest fieldAnnotation) → String?: Given each field, determine whether it can be added to the serdes function and, more importantly, determine how it should be added. If the field should not be added, return null.
inherited
checkerForField(FieldElement field) → SharedChecker<Model>: Return a SharedChecker for a type via the corresponding parameter in the constructor.
inherited
checkerForType(DartType type) → SharedChecker<Model>: Return a SharedChecker for a type. If including a custom checker in your domain, overwrite this field
inherited
coderForField(FieldElement field, SharedChecker<Model> checker, {required bool wrappedInFuture, required Rest fieldAnnotation}) → String?: Produces serializing or deserializing method given a field and checker.
inherited
deserializerNullableClause({required FieldElement field, required Rest fieldAnnotation, required String name}) → String: Injected between the field member in the constructor and the contents
inherited
digestPlaceholders(String? input, String annotatedName, String fieldName) → String?: Replace default placeholders
inherited
expandGenerators(Rest annotation, {required FieldElement field, required SharedChecker<Model> checker}) → String?: Convert placeholders in fromGenerator and toGenerator to functions.
inherited
generate() → String: Wraps fieldsForGenerator in a method to produce serialization or deserialization
inherited
getAssociationMethod(DartType argType, {bool forceNullable = false, required String query}) → String: Generates a repository.getAssociation invocation
inherited
hasConstructor(DartType type) → bool: If this class possesses a factory such as fromRest
inherited
hasSerializer(DartType type) → bool: If this class possesses a serializing method such as toSqlite
inherited
ignoreCoderForField(FieldElement field, Rest annotation, SharedChecker<Model> checker) → bool: Determine whether this field should be included in generated output.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
providerNameForField(String? annotatedName, {required SharedChecker<Model> checker}) → String: The field's name when being serialized to a provider. Optionally, a checker can reveal the field's purpose.
inherited
serdesValueForField(FieldElement field, String annotatedName, {required SharedChecker<Model> checker}) → String: The field's value when used by the generator. For example, data['my_field'] when used by a deserializing generator or instance.myField when used by a serializing generator
inherited
toString() → String: A string representation of this object.
inherited

Operators

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