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

# `with` — owned chainable setters

The `with` method generates an owned setter prefixed with `with_`, consuming and returning `Self`.
This is the idiomatic pattern for builder-style initialization. Generated methods are marked
`#[must_use]` to catch accidentally discarding the returned value.

When [`without`](crate::without) is also enabled, `with` changes behavior for `bool` and `Option`
fields: `with_field()` sets to `true`/`Some(value)` and `without_field()` sets to `false`/`None`.
See [`without`](crate::without) for details.

```rust
#[derive(fieldwork::Fieldwork)]
#[fieldwork(with)]
struct Request {
    /// request URL
    url: String,

    /// optional auth token
    token: Option<String>,

    /// whether to follow redirects
    follow_redirects: bool,
}
```

```rust
// GENERATED
# struct Request { url: String, token: Option<String>, follow_redirects: bool, }
impl Request {
    ///Owned chainable setter for request URL, returning `Self`
    #[must_use]
    pub fn with_url(mut self, url: String) -> Self {
        self.url = url;
        self
    }
    ///Owned chainable setter for optional auth token, returning `Self`
    #[must_use]
    pub fn with_token(mut self, token: Option<String>) -> Self {
        self.token = token;
        self
    }
    ///Owned chainable setter for whether to follow redirects, returning `Self`
    #[must_use]
    pub fn with_follow_redirects(mut self, follow_redirects: bool) -> Self {
        self.follow_redirects = follow_redirects;
        self
    }
}

```

## Enums

On enums, `with` is only generated for full-coverage fields. See
[`enums`](crate::enums).

## Options

| Option | Description |
|--------|-------------|
| [`into`](crate::with::into) | Accept `impl Into<T>` instead of `T` |
| [`option_set_some`](crate::with::option_set_some) | Accept `T` and wrap in `Some` for `Option<T>` fields |

Both options are shared with [`set`](crate::set) and documented at the crate level:
[`into`](crate::into), [`option_set_some`](crate::option_set_some).