brk_traversable_derive 0.2.5

Derive for brk_vec's used in BRK
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

# brk_traversable_derive

Proc-macro for deriving the `Traversable` trait on data structures.

## What It Enables

Automatically generate tree traversal and export iteration for structs, eliminating boilerplate when working with hierarchical data that needs serialization or inspection.

## Key Features

- **Automatic tree building**: Converts struct fields into `TreeNode::Branch` hierarchies
- **Export iteration**: Generates `iter_any_exportable()` to walk all exportable vectors
- **Field attributes**: `#[traversable(skip)]` to exclude fields, `#[traversable(flatten)]` to merge nested structures
- **Option support**: Gracefully handles `Option<T>` fields
- **Generic-aware**: Properly bounds generic parameters with `Traversable + Send + Sync`

## Core API

```rust,ignore
#[derive(Traversable)]
struct MyData {
    pub metrics: MetricsCollection,
    #[traversable(flatten)]
    pub nested: NestedData,
    #[traversable(skip)]
    internal: Cache,
}
```

## Generated Methods

- `to_tree_node(&self) -> TreeNode` - Build navigable tree structure
- `iter_any_exportable(&self) -> impl Iterator<Item = &dyn AnyExportableVec>` - Iterate all exportable vectors