Crate optionable_codegen

Crate optionable_codegen 

Source
Expand description

The relevant main crate is optionable. The docs can be found there.

§Purpose

This code generation proc_macro2 library serves two purposes:

  • Used by optionable_derive to implement the #[derive(Optionable)]-macro re-exported by optionable.
  • Used by the bin/codegen.rs crate to support generating Optionable-implementations for external packages. Due to the orphan rule the generated code has to be added to the Optionable-package (PRs welcome).

It has to be a separate crate from optionable_derive as the proc-macro crates can’t export its non-macro functions (even the proc_macro2 ones) for the usage by the codegen part.

Structs§

CodegenSettings
Settings that are only available to be set via the rust function signature of derive_optionable but not via the derive macro (as they are not useful in that context and would lead to an increased but not useful API surface of the derive macro helpers).
FieldAttributeToCopy
Forwards the specified attr to the definition of the optioned type. If sub_names is set it filters the configuration of the forwarded attribure for the specified configuration names. E.g. attr=serde,sub_names=rename will only forward the renamesub-attribute of serde.

Functions§

attribute_derives
Returns the attribute for setting that the given identifiers should be added as derive macro to the optioned struct/enum.
attribute_no_convert
Returns the attribute for opting-out of OptionableConvert-impl generation.
attribute_suffix
Returns the attribute for setting a custom struct/enum name suffix instead of Opt.
derive_optionable
Derives the Optionable-trait from the main optionable-library.