field_path 0.4.1

Type-safe, no-std field access and reflection utilities.
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

# Field Path


[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/voxell-tech/field_path#license)
[![Crates.io](https://img.shields.io/crates/v/field_path.svg)](https://crates.io/crates/field_path)
[![Downloads](https://img.shields.io/crates/d/field_path.svg)](https://crates.io/crates/field_path)
[![Docs](https://docs.rs/field_path/badge.svg)](https://docs.rs/field_path/latest/field_path/)
[![CI](https://github.com/voxell-tech/field_path/workflows/CI/badge.svg)](https://github.com/voxell-tech/field_path/actions)
[![Discord](https://img.shields.io/discord/442334985471655946.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/Mhnyp6VYEQ)

**Field Path** provides a lightweight and type-safe abstraction for
referencing and accessing nested fields within structs.

The crate is designed to make it easier to generically inspect or
mutate fields without relying on heavy reflection systems or unsafe
code. It does this through a combination of field identifiers and
accessors that preserve type information.

## Core Concepts


- `Field`: Represents a unique, type-safe identifier for a
  field path within a struct.
- `Accessor`: A generic wrapper providing read and write access
  to a field.
- `FieldAccessor`: A container pairing a `Field` with its `Accessor`,
  ensuring both always refer to the same field path.

Together, these components allow building flexible systems that can
access or manipulate struct data without tightly coupling to specific
types.

## Example


```rust
use field_path::field_accessor;
use field_path::field_accessor::FieldAccessor;

#[derive(Default)]

struct Vec2<T> {
    pub x: T,
    pub y: T,
}

const FIELD_ACC: FieldAccessor<Vec2<f32>, f32> = field_accessor!(<Vec2<f32>>::x);

assert_eq!(FIELD_ACC.field.field_path(), "::x");

let mut v = Vec2::default();
*FIELD_ACC.accessor.get_mut(&mut v) = 42.0;
assert_eq!(FIELD_ACC.accessor.get_ref(&v), &42.0);
```

## Join the community!


You can join us on the [Voxell discord server](https://discord.gg/Mhnyp6VYEQ).

## License


`field_path` is dual-licensed under either:

- MIT License ([LICENSE-MIT](LICENSE-MIT) or [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT))
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))

This means you can select the license you prefer!
This dual-licensing approach is the de-facto standard in the Rust ecosystem and there are [very good reasons](https://github.com/bevyengine/bevy/issues/2373) to include both.