fieldwork 0.5.1

derivable accessors for struct fields
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

# `get` — immutable field accessors

The `get` method generates an immutable accessor for each field. Fieldwork applies several smart
defaults to make getters idiomatic without configuration:

- **Copy types** (`bool`, integers, `char`, `&T`) are returned by value rather than by reference
- **Common owned types** (`String`, `Vec<T>`, `PathBuf`, etc.) return their borrowed form (`&str`,
  `&[T]`, `&Path`, etc.) — see [`get::deref`](crate::get::deref)
- **`Option` fields** return `Option<&T>` or `Option<&BorrowedT>` rather than `&Option<T>` — see
  [`get::option_borrow_inner`](crate::get::option_borrow_inner)

```rust
#[derive(fieldwork::Fieldwork)]
#[fieldwork(get)]
struct User {
    /// whether this user is an admin
    admin: bool,

    /// the user's name
    name: String,

    /// the user's age, if known
    age: Option<u8>,

    /// favorite color, if set
    favorite_color: Option<String>,
}
```

```rust
// GENERATED
# struct User { admin: bool, name: String, age: Option<u8>, favorite_color: Option<String>, }
impl User {
    ///Returns a copy of whether this user is an admin
    pub fn admin(&self) -> bool {
        self.admin
    }
    ///Borrows the user's name
    pub fn name(&self) -> &str {
        &*self.name
    }
    ///Returns a copy of the user's age, if known
    pub fn age(&self) -> Option<u8> {
        self.age
    }
    ///Borrows favorite color, if set
    pub fn favorite_color(&self) -> Option<&str> {
        self.favorite_color.as_deref()
    }
}

```

## Enums

On enums, `get` determines the return type based on field coverage. See
[`enums`](crate::enums) for the full/partial coverage concept.

```rust
#[derive(fieldwork::Fieldwork)]
#[fieldwork(get)]
enum Packet {
    Data { id: u32, payload: String },
    Heartbeat { id: u32 },
}
```

```rust
// GENERATED
# enum Packet { Data { id: u32, payload: String }, Heartbeat { id: u32 }, }
impl Packet {
    pub fn id(&self) -> u32 {
        match self {
            Self::Data { id, .. } | Self::Heartbeat { id, .. } => *id,
        }
    }
    pub fn payload(&self) -> Option<&str> {
        match self {
            Self::Data { payload, .. } => Some(&**payload),
            _ => None,
        }
    }
}

```

`id` appears in both variants (full coverage): returns `u32` by value (Copy).
`payload` appears in only `Data` (partial coverage): returns `Option<&str>`.
Smart defaults (deref, option unwrapping) apply to the inner type for partial
fields just as they do for struct fields.

## Options

| Option | Description |
|--------|-------------|
| [`copy`](crate::get::copy) | Return by value instead of by reference |
| [`deref`](crate::get::deref) | Control automatic dereferencing to borrowed types |
| [`option_borrow_inner`](crate::get::option_borrow_inner) | Control how `Option` fields are returned |
| [`rename_predicates`](crate::get::rename_predicates) | Prefix `bool`-returning getters with `is_` |

All options can be set at the item level (`#[fieldwork(get(copy = false))]`), per-field
(`#[field(get(copy))]`), or combined with field-level configuration
(`#[field(copy)]` applies to all methods for that field). See [`configuration`](crate::configuration)
for the full cascade rules.