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

# `get_mut` — mutable field accessors

The `get_mut` method generates a mutable accessor named `field_name_mut`. It follows the same
dereferencing and option-unwrapping rules as [`get`](crate::get), returning `&mut BorrowedType`
for owned types and `Option<&mut T>` for option fields.

```rust
#[derive(fieldwork::Fieldwork)]
#[fieldwork(get_mut)]
struct User {
    /// 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 { name: String, age: Option<u8>, favorite_color: Option<String>, }
impl User {
    ///Mutably borrow the user's name
    pub fn name_mut(&mut self) -> &mut str {
        &mut *self.name
    }
    ///Mutably borrow the user's age, if known
    pub fn age_mut(&mut self) -> Option<&mut u8> {
        self.age.as_mut()
    }
    ///Mutably borrow favorite color, if set
    pub fn favorite_color_mut(&mut self) -> Option<&mut str> {
        self.favorite_color.as_deref_mut()
    }
}

```

## Enums

`get_mut` follows the same full/partial coverage rules as `get`: full-coverage
fields return `&mut T` (or `&mut BorrowedT`), partial-coverage fields return
`Option<&mut T>`. See [`enums`](crate::enums).

## Options

`get_mut` shares its configuration options with `get`:

| Option | Description |
|--------|-------------|
| [`deref`](crate::get_mut::deref) | Control automatic dereferencing |
| [`option_borrow_inner`](crate::get_mut::option_borrow_inner) | Control how `Option` fields are returned |

Note that `copy` and `rename_predicates` do not apply to `get_mut` — mutable accessors always
return references, and the `_mut` suffix already distinguishes them from `get`.