easy-macros-helpers 0.1.2

Easy Macros support library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

# What is this?

[![Crates.io](https://img.shields.io/crates/v/easy-macros-helpers.svg)](https://crates.io/crates/easy-macros-helpers)

Easy Macros Helpers is a collection of utility functions provided and used by the [Easy Macros crate](https://crates.io/crates/easy_macros)

## Core Features

### Error Context Generation

- [`context!`](https://docs.rs/easy-macros-helpers/latest/easy_macros_helpers_macro_safe/macro.context.html) - Generate context strings for error handling with automatic file/line information

### Token Stream Management

- [`TokensBuilder`](https://docs.rs/easy-macros-helpers/latest/easy_macros_helpers_macro_safe/struct.TokensBuilder.html) - Accumulate and combine token streams with methods inside
- [`readable_token_stream`](https://docs.rs/easy-macros-helpers/latest/easy_macros_helpers_macro_safe/fn.readable_token_stream.html) - Format token strings for better readability
- [`token_stream_to_consistent_string`](https://docs.rs/easy-macros-helpers/latest/easy_macros_helpers_macro_safe/fn.token_stream_to_consistent_string.html) - Normalize token representation across contexts

### Error Handling

- [`parse_macro_input!`](https://docs.rs/easy-macros-helpers/latest/easy_macros_helpers_macro_safe/macro.parse_macro_input.html) - Enhanced version of syn's macro that returns `Ok(TokenStream)` on parse errors (instead of `TokenStream`)
- [`expr_error_wrap`](https://docs.rs/easy-macros-helpers/latest/easy_macros_helpers_macro_safe/fn.expr_error_wrap.html) with [`CompileErrorProvider`](https://docs.rs/easy-macros-helpers/latest/easy_macros_helpers_macro_safe/trait.CompileErrorProvider.html) trait - Wrap expressions with compile-time error reporting

### Code Generation Utilities

- [`indexed_name`](https://docs.rs/easy-macros-helpers/latest/easy_macros_helpers_macro_safe/fn.indexed_name.html) - Generate indexed identifiers (`field0`, `field1`, etc.)
- [`find_crate`](https://docs.rs/easy-macros-helpers/latest/easy_macros_helpers_macro_safe/fn.find_crate.html) - Locate crate references for generated code (supports renaming)
- [`find_crate_list`](https://docs.rs/easy-macros-helpers/latest/easy_macros_helpers_macro_safe/fn.find_crate_list.html) - Try multiple crates, return first found

## Examples

### Using `context!` for Error Handling

<!-- docify::embed!("src/examples.rs", readme_context_basic_example) -->

### Using `TokensBuilder` for Token Accumulation

<!-- docify::embed!("src/examples.rs", readme_tokens_builder_example) -->

### Support for `Result<TokenStream, ...>` with `parse_macro_input!`

```rust,ignore
#[proc_macro]
#[anyhow_result]
fn my_macro(input: TokenStream) -> anyhow::Result<TokenStream> {
    //This doesn't return TokenStream on compile errors, but Ok(TokenStream) with compile_error! inside
    let parsed = parse_macro_input!(input as syn::DeriveInput);

    // Process parsed input...
    Ok(quote::quote! {
        // Generated code
    }.into())
}
```

### Generating Indexed Names

<!-- docify::embed!("src/examples.rs", readme_indexed_name_example) -->

### Error Wrapping for Better Diagnostics

<!-- docify::embed!("src/examples.rs", readme_error_wrapping_example) -->

### Finding Crate References (with Renaming Support)

<!-- docify::embed!("src/examples.rs", readme_find_crate_example) -->