most_mapper library
Public API for parsing Most Mapper YAML schemas and generating mapper code.
Classes
- ConverterDef
- Converter definition between two schema types.
- CSharpCodeSpec
- C# converter code specification.
- DartCodeSpec
- Dart converter code specification.
- DataModelDef
- Data-class model definition.
- EnumModelDef
- Enum model definition.
- EnumValueDef
- Single enum value definition.
- FieldDef
- Data model field definition.
- FieldMapping
- Explicit mapping for one target field.
- GenerationResult
- Result of a completed generation run.
- GeneratorOptions
- File-system options used by generate.
- MapperSchema
- Parsed mapping schema.
- MappingDef
- Mapping definition between two models.
- ModelDef
- Base definition for a generated model.
- TypeRef
- Parsed type reference used by fields, converters, and mappings.
- UnionModelDef
- Closed tagged-union model definition.
- UnionVariantDef
- One concrete variant of a tagged union.
Constants
- defaultCSharpFileName → const String
- Default generated C# mapper file name.
- defaultDartFileName → const String
- Default generated Dart mapper file name.
Functions
-
generate(
GeneratorOptions options) → GenerationResult -
Generates mapper files from the YAML mapping described by
options. -
parseMappingYaml(
String source, {String sourceName = 'mapping.yaml'}) → MapperSchema - Parses a YAML mapping document into a MapperSchema.
Exceptions / Errors
- MapperException
- Error thrown when parsing, validation, or generation fails.