Crate macro_tools

Module :: proc_macro_tools

Tools for writing procedural macros.

Basic use-case

#[ cfg( feature = "enabled" ) ]
{
  use macro_tools::exposed::*;

  let code = qt!( core::option::Option< i8, i16, i32, i64 > );
  let tree_type = syn::parse2::< syn::Type >( code ).unwrap();
  let got = typ::type_parameters( &tree_type, 0..=2 );
  got.iter().for_each( | e | println!( "{}", qt!( #e ) ) );
  /* print :
    i8
    i16
    i32
  */
}

To add to your project

cargo add proc_macro_tools

Try out from the repository

git clone https://github.com/Wandalen/wTools
cd wTools
cd examples/macro_tools_trivial
cargo run

Modules

• attr
  Protected namespace of the module.
• container_kind
  Protected namespace of the module.
• dependency
  Dependencies of the module.
• derive
  Protected namespace of the module.
• diag
  Protected namespace of the module.
• drop
  Protected namespace of the module.
• exposed
  Exposed namespace of the module.
• generic_args
  Protected namespace of the module.
• generic_params
  Functions and structures to handle and manipulate generic parameters using the syn crate. It’s designed to support macro-driven code generation by simplifying, merging, extracting, and decomposing syn::Generics.
• item
  This module provides various utilities and namespaces for working with syn::Item, specifically focusing on ensuring syntactical correctness and managing different visibility levels within the code. It includes functions to manipulate the structure of items, handle different kinds of fields, and provide a structured approach to organizing the codebase into different access levels.
• item_struct
  Protected namespace of the module.
• iter
  Protected namespace of the module.
• name
  Protected namespace of the module.
• orphan
  Parented namespace of the module.
• phantom
  Responsible for generating marker PhantomData fields to avoid the rule requiring the usage of all generic parameters in a struct. This is often necessary to ensure that Rust’s type system correctly tracks the ownership and lifetimes of these parameters without needing them to be explicitly used in the struct’s fields.
• prelude
  Prelude to use essentials: use my_module::prelude::*.
• proc_macro2
  github crates-io docs-rs
• protected
  Protected namespace of the module.
• punctuated
  Structures and functions for handling syn::punctuated::Punctuated collections.
• quantifier
  Protected namespace of the module.
• quote
  github crates-io docs-rs
• struct_like
  Protected namespace of the module.
• syn
  github crates-io docs-rs
• tokens
  Protected namespace of the module.
• typ
  Protected namespace of the module.

Macros

• Token
  A type-macro that expands to the name of the Rust type representation of a given token.
• braced
  Parse a set of curly braces and expose their content to subsequent parsers.
• bracketed
  Parse a set of square brackets and expose their content to subsequent parsers.
• code_diagnostics_str
  Macro for diagnostics purpose to diagnose source code behind it and export it into a string.
• code_print
  Macro for diagnostics purpose to print both syntax tree and source code behind it without syntax tree.
• code_to_str
  Macro to export source code behind a syntax tree into a string.
• custom_keyword
  Define a type that supports parsing and printing a given identifier as if it were a keyword.
• custom_punctuation
  Define a type that supports parsing and printing a multi-character symbol as if it were a punctuation token.
• format_ident
  Formatting macro for constructing Idents.
• parenthesized
  Parse a set of parentheses and expose their content to subsequent parsers.
• parse_macro_input
  Parse the input TokenStream of a macro, triggering a compile error if the tokens fail to parse.
• parse_qt
  Quasi-quotation macro that accepts input like the quote! macro but uses type inference to figure out a return type for those tokens.
• parse_quote
  Quasi-quotation macro that accepts input like the quote! macro but uses type inference to figure out a return type for those tokens.
• parse_quote_spanned
  This macro is parse_quote! + quote_spanned!.
• qt
• quote
• quote_spanned
• return_syn_err
  Macro to generate syn error either with span of a syntax tree element or with default one proc_macro2::Span::call_site().
• syn_err
  Macro to generate syn error either with span of a syntax tree element or with default one proc_macro2::Span::call_site().
• tree_diagnostics_str
  Macro for diagnostics purpose to export both syntax tree and source code behind it into a string.
• tree_print
  Macro for diagnostics purpose to print both syntax tree and source code behind it with syntax tree.

Structs

• AttributesInner
  Attribute which is inner.
• AttributesOuter
  Represents a collection of outer attributes.
• Equation
  Represents an equation parsed from a procedural macro input.
• GenericsWithWhere
  A GenericsWithWhere struct to handle the parsing of Rust generics with an explicit where clause.
• Many
  Parse as much elements as possible.
• Pair
  Pair of two elements of parsing.
• Tokens
  Tokens is a wrapper around proc_macro2::TokenStream. It is designed to facilitate the parsing and manipulation of token streams within procedural macros.

Traits

• AsMuchAsPossibleNoDelimiter
  Marker saying how to parse several elements of such type in a row.
• IntoGenericArgs
  A trait for converting a reference to an existing type into a syn::AngleBracketedGenericArguments.
• IntoInterval
  Convert it into canonical interval.
• IterTrait
  Trait that encapsulates an iterator with specific characteristics, tailored for use with the syn crate.
• IterableInterval
  Interval adapter. Interface to interval-like structures.
• Name
  Trait to get name of an syntax element.
• NonIterableInterval
  Interval adapter. Interface to interval-like structures.
• Spanned
  A trait that can provide the Span of the complete contents of a syntax tree node.

Functions

• equation
  For attribute like #[former( default = 31 ) ] return key default and value 31, as well as syn::Meta as the last element of result tuple.
• has_debug
  Checks if the given iterator of attributes contains an attribute named debug.
• indentation
  Adds indentation and optional prefix/postfix to each line of the given string.
• is_standard
  Checks if the given attribute name is a standard Rust attribute.
• report_format
  Formats a debugging report for code transformation processes, detailing both the original and generated code for easy comparison and review.
• report_print
  Prints a debugging report for a pair of token streams to the standard output.

Type Aliases

• ParseStream
  Input to a Syn parser function.
• Result
  Result with syn::Error.