darling_core

Helper crate for proc-macro library for reading attributes into structs when implementing custom derives. Use https://crates.io/crates/darling in your code.

21 releases (6 breaking)

0.7.0 Jul 24, 2018
0.5.0 May 10, 2018
0.3.2 Mar 13, 2018
0.2.2 Dec 5, 2017
0.2.0 Jun 19, 2017

#11 in Procedural macro helpers

Download history 506/week @ 2018-07-18 590/week @ 2018-07-25 550/week @ 2018-08-01 527/week @ 2018-08-08 650/week @ 2018-08-15 467/week @ 2018-08-22 468/week @ 2018-08-29 789/week @ 2018-09-05 765/week @ 2018-09-12 797/week @ 2018-09-19 860/week @ 2018-09-26 912/week @ 2018-10-03 1007/week @ 2018-10-10

2,344 downloads per month
Used in 29 crates (2 directly)

MIT license

175KB
4.5K SLoC

Darling

Build Status Latest Version

darling is a crate for proc macro authors, which enables parsing attributes into structs. It is heavily inspired by serde both in its internals and in its API.

Usage

darling provides a set of traits which can be derived or manually implemented.

  1. FromMeta is used to extract values from a meta-item in an attribute. Implementations are likely reusable for many libraries, much like FromStr or serde::Deserialize. Trait implementations are provided for primitives, some std types, and some syn types.
  2. FromDeriveInput is implemented or derived by each proc-macro crate which depends on darling. This is the root for input parsing; it gets access to the identity, generics, and visibility of the target type, and can specify which attribute names should be parsed or forwarded from the input AST.
  3. FromField is implemented or derived by each proc-macro crate which depends on darling. Structs deriving this trait will get access to the identity (if it exists), type, and visibility of the field.

Example

#[macro_use]
extern crate darling;
extern crate syn;

#[derive(Default, FromMeta)]
#[darling(default)]
pub struct Lorem {
    #[darling(rename = "sit")]
    ipsum: bool,
    dolor: Option<String>,
}

#[derive(FromDeriveInput)]
#[darling(from_ident, attributes(my_crate), forward_attrs(allow, doc, cfg))]
pub struct MyTraitOpts {
    ident: syn::Ident,
    attrs: Vec<syn::Attribute>,
    lorem: Lorem,
}

The above code will then be able to parse this input:

/// A doc comment which will be available in `MyTraitOpts::attrs`.
#[derive(MyTrait)]
#[my_crate(lorem(dolor = "Hello", ipsum))]
pub struct ConsumingType;

Features

Darling's features are built to work well for real-world projects.

  • Defaults: Supports struct- and field-level defaults, using the same path syntax as serde.
  • Field Renaming: Fields can have different names in usage vs. the backing code.
  • Auto-populated fields: Structs deriving FromDeriveInput and FromField can declare properties named ident, vis, ty, attrs, and generics to automatically get copies of the matching values from the input AST. FromDeriveInput additionally exposes data to get access to the body of the deriving type, and FromVariant exposes fields.
  • Mapping function: Use #[darling(map="path")] to specify a function that runs on the result of parsing a meta-item field. This can change the return type, which enables you to parse to an intermediate form and convert that to the type you need in your struct.
  • Skip fields: Use #[darling(skip)] to mark a field that shouldn't be read from attribute meta-items.
  • Multiple-occurrence fields: Use #[darling(multiple)] on a Vec field to allow that field to appear multiple times in the meta-item. Each occurrence will be pushed into the Vec.

Dependencies

~1MB
~20K SLoC