Darling is a tool for declarative attribute parsing in proc macro implementations.
Darling takes considerable design inspiration from
serde. A data structure that can be
read from any attribute implements
FromMeta (or has an implementation automatically
derive). Any crate can provide
FromMeta implementations, even one not
specifically geared towards proc-macro authors.
Proc-macro crates should provide their own structs which implement or derive
FromGenerics, et alia to gather settings relevant to their operation.
There are a number of attributes that
darling exposes to enable finer-grained control over the code
- Field renaming: You can use
#[darling(rename="new_name")]on a field to change the name Darling looks for. You can also use
#[darling(rename_all="...")]at the struct or enum level to apply a casing rule to all fields or variants.
- Map function: You can use
#[darling(map="path::to::function")]to run code on a field before its stored in the struct.
- Default values: You can use
#[darling(default)]at the type or field level to use that type’s default value to fill in values not specified by the caller.
- Skipped fields: You can skip a variant or field using
#[darling(skip)]. Fields marked with this will fall back to
Default::default()for their value, but you can override that with an explicit default or a value from the type-level default.
All derivable traits except
FromMeta support forwarding some fields from the input AST to the derived struct.
These fields are matched up by identifier before
rename attribute values are considered,
allowing you to use their names for your own properties.
The deriving struct is responsible for making sure the types of fields it chooses to declare are compatible with this table.
A deriving struct is free to include or exclude any of the fields below.
|The identifier of the passed-in type
|The visibility of the passed-in type
|The generics of the passed-in type. This can be
darling::ast::Generics, or any compatible type.
|The body of the passed-in type
|The forwarded attributes from the passed in type. These are controlled using the
|The identifier of the passed-in field, or
None for tuple fields
|The visibility of the passed-in field
|The type of the passed-in field
|The forwarded attributes from the passed in field. These are controlled using the
|The identifier of the passed-in type param
|The bounds applied to the type param
|The default type of the parameter, if one exists
|The forwarded attributes from the passed in type param. These are controlled using the
|The identifier of the passed-in variant
|For a variant such as
Example = 2, the
darling::ast::Fields<T> where T: FromField
|The fields associated with the variant
|The forwarded attributes from the passed in variant. These are controlled using the
- Utility types for working with the AST.
darling::Errortype, the multiple error
Accumulator, and their internals.
- Traits and types used for tracking the usage of generic parameters through a proc-macro input.
- Utility types for attribute parsing.
- Generator for
UsesLifetimesimpls that unions the used lifetimes of the selected fields.
- Generator for
UsesTypeParamimpls that unions the used type parameters of the selected fields.
- An error encountered during attribute parsing.
- Create an instance by parsing a list of attributes.
- Creates an instance by parsing an entire proc-macro
deriveinput, including the, identity, generics, and visibility of the type.
- Creates an instance by parsing an individual field and its attributes.
- Creates an instance by parsing a specific
syn::GenericParam. This can be a type param, a lifetime, or a const param.
- Creates an instance by parsing an entire generics declaration, including the
- Create an instance from an item in an attribute declaration.
- Creates an instance by parsing an individual type_param and its attributes.
- Creates an instance from a specified
- An alias of
Resultspecific to attribute parsing.