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
105
106
107
108
109
110
111
112
113
114

#![forbid(unsafe_code, future_incompatible)]
#![deny(
    missing_debug_implementations,
    nonstandard_style,
    missing_copy_implementations,
    unused_qualifications,
    missing_docs,
    rustdoc::missing_crate_level_docs
)]
#![warn(clippy::pedantic)]
//! `fieldwork` generates field accessor methods for structs and enums via a
//! derive macro.
//!
//! Add [`#[derive(Fieldwork)]`](derive@Fieldwork) to a struct or enum, then
//! declare which methods to generate with `#[fieldwork(...)]` on the item and
//! refine individual fields with `#[field(...)]`.
//!
//! ## Methods
//!
//! | Module | Generated method | Description |
//! |--------|-----------------|-------------|
//! | [`get`] | `field_name()` | Borrow or copy a field |
//! | [`set`] | `set_field_name()` | Mutating setter, returns `&mut Self` by default |
//! | [`get_mut`] | `field_name_mut()` | Mutably borrow a field |
//! | [`with`] | `with_field_name()` | Owned chainable setter |
//! | [`without`] | `without_field_name()` | Set bool to `false` or Option to `None` |
//! | [`take`] | `take_field_name()` | Take the value out of an `Option` field |
//! | [`into_field`] | `into_field_name()` | Consume `self`, returning an owned field value |
//!
//! ## Enum support
//!
//! All method types work on enums. Whether a field appears in all variants or
//! only some determines the return type and whether setters are generated. See
//! [`enums`] for the full/partial coverage concept and examples.
//!
//! ## Configuration
//!
//! Fieldwork has four levels of configuration that cascade from broadest to most specific.
//! See [`configuration`] for a full explanation.
//!
//! Options shared across setter methods ([`into`], [`option_set_some`]) are documented at the
//! top level since they apply equally to [`set`] and [`with`].

pub use fieldwork_derive::Fieldwork;

#[cfg(doc)]
#[doc = include_str!("../docs/get.md")]
pub mod get {
    #[doc = include_str!("../docs/get/copy.md")]
    pub mod copy {}
    #[doc = include_str!("../docs/get/deref.md")]
    pub mod deref {}
    #[doc = include_str!("../docs/get/option_borrow_inner.md")]
    pub mod option_borrow_inner {}
    #[doc = include_str!("../docs/get/rename_predicates.md")]
    pub mod rename_predicates {}
}

#[cfg(doc)]
#[doc = include_str!("../docs/set.md")]
pub mod set {
    #[doc = include_str!("../docs/set/chain.md")]
    pub mod chain {}
    #[doc = include_str!("../docs/into.md")]
    pub mod into {}
    #[doc = include_str!("../docs/option_set_some.md")]
    pub mod option_set_some {}
}

#[cfg(doc)]
#[doc = include_str!("../docs/get_mut.md")]
pub mod get_mut {
    #[doc = include_str!("../docs/get/deref.md")]
    pub mod deref {}
    #[doc = include_str!("../docs/get/option_borrow_inner.md")]
    pub mod option_borrow_inner {}
}

#[cfg(doc)]
#[doc = include_str!("../docs/with.md")]
pub mod with {
    #[doc = include_str!("../docs/into.md")]
    pub mod into {}
    #[doc = include_str!("../docs/option_set_some.md")]
    pub mod option_set_some {}
}

#[cfg(doc)]
#[doc = include_str!("../docs/without.md")]
pub mod without {}

#[cfg(doc)]
#[doc = include_str!("../docs/take.md")]
pub mod take {}

#[cfg(doc)]
#[doc = include_str!("../docs/into_field.md")]
pub mod into_field {}

#[cfg(doc)]
#[doc = include_str!("../docs/into.md")]
pub mod into {}

#[cfg(doc)]
#[doc = include_str!("../docs/option_set_some.md")]
pub mod option_set_some {}

#[cfg(doc)]
#[doc = include_str!("../docs/enums.md")]
pub mod enums {}

#[cfg(doc)]
#[doc = include_str!("../docs/configuration.md")]
pub mod configuration {}