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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
//! A Rust validation library
//!
//! - [Basic usage example](#basic-usage-example)
//! - [Validation rules](#available-validation-rules)
//! - [Inner type validation](#inner-type-validation)
//! - [Handling Option](#handling-option)
//! - [Custom validation](#custom-validation)
//! - [Implementing rules](#implementing-rules)
//! - [Implementing `Validate`](#implementing-validate)
//! - [Integration with web frameworks](#integration-with-web-frameworks)
//! - [Feature flags](#feature-flags)
//! - [Why `garde`?](#why-garde)
//!
//! ### Basic usage example
//!
//! To get started, use the [`Validate`][`crate::Validate`] derive macro and add some validation rules to your type.
//! This generates an implementation of the [`Validate`][`crate::Validate`] trait for you.
//! To use it, call the [`validate`][`crate::Validate::validate`] method on an instance of the type.
//!
//! Here's what that looks like in full:
//!
//! ```rust
//! use garde::{Validate, Valid};
//!
//! #[derive(Validate)]
//! struct User<'a> {
//! #[garde(ascii, length(min=3, max=25))]
//! username: &'a str,
//! #[garde(length(min=15))]
//! password: &'a str,
//! }
//!
//! let user = User {
//! username: "test",
//! password: "not_a_very_good_password",
//! };
//!
//! if let Err(e) = user.validate(&()) {
//! println!("invalid user: {e}");
//! }
//! ```
//!
//! Garde can also validate enums:
//!
//! ```rust
//! use garde::{Validate, Valid};
//!
//! #[derive(Validate)]
//! enum Data {
//! Struct {
//! #[garde(range(min=-10, max=10))]
//! field: i32,
//! },
//! Tuple(
//! #[garde(ascii)]
//! String
//! ),
//! }
//!
//! let data = Data::Struct { field: 100 };
//! if let Err(e) = data.validate(&()) {
//! println!("invalid data: {e}");
//! }
//! ```
//!
//! ### Available validation rules
//!
//! | name | format | validation | feature flag |
//! | ------------ | ------------------------------------------------ | ---------------------------------------------------- | -------------- |
//! | required | `#[garde(required)]` | is value set | - |
//! | ascii | `#[garde(ascii)]` | only contains ASCII | - |
//! | alphanumeric | `#[garde(alphanumeric)]` | only letters and digits | - |
//! | email | `#[garde(email)]` | an email according to the HTML5 spec[^1] | `email` |
//! | url | `#[garde(url)]` | a URL | `url` |
//! | ip | `#[garde(ip)]` | an IP address (either IPv4 or IPv6) | - |
//! | ipv4 | `#[garde(ipv4)]` | an IPv4 address | - |
//! | ipv6 | `#[garde(ipv6)]` | an IPv6 address | - |
//! | credit card | `#[garde(credit_card)]` | a credit card number | `credit-card` |
//! | phone number | `#[garde(phone_number)]` | a phone number | `phone-number` |
//! | length | `#[garde(length(min=<usize>, max=<usize>)]` | a container with length in `min..=max` | - |
//! | byte_length | `#[garde(byte_length(min=<usize>, max=<usize>)]` | a byte sequence with length in `min..=max` | - |
//! | range | `#[garde(range(min=<expr>, max=<expr>))]` | a number in the range `min..=max` | - |
//! | contains | `#[garde(contains(<string>))]` | a string-like value containing a substring | - |
//! | prefix | `#[garde(prefix(<string>))]` | a string-like value prefixed by some string | - |
//! | suffix | `#[garde(suffix(<string>))]` | a string-like value suffixed by some string | - |
//! | pattern | `#[garde(pattern("<regex>"))]` | a string-like value matching some regular expression | `regex` |
//! | pattern | `#[garde(pattern(<matcher>))]` | a string-like value matched by some [`Matcher`][rules::pattern::Matcher] | - |
//! | dive | `#[garde(dive)]` | nested validation, calls `validate` on the value | - |
//! | skip | `#[garde(skip)]` | skip validation | - |
//! | custom | `#[garde(custom(<function or closure>))]` | a custom validator | - |
//!
//! Additional notes:
//! - `required` is only available for `Option` fields.
//! - For `length` and `range`, either `min` or `max` may be omitted, but not both.
//! - `length` and `range` use an *inclusive* upper bound (`min..=max`).
//! - `length` uses `.chars().count()` for UTF-8 strings instead of `.len()`.
//! - For `contains`, `prefix`, and `suffix`, the pattern must be a string literal, because the `Pattern` API [is currently unstable](https://github.com/rust-lang/rust/issues/27721).
//! - Garde does not enable the default features of the `regex` crate - if you need extra regex features (e.g. Unicode) or better performance, add a dependency on `regex = "1"` to your `Cargo.toml`.
//!
//! If most of the fields on your struct are annotated with `#[garde(skip)]`, you may use `#[garde(allow_unvalidated)]` instead:
//!
//! ```rust
//! #[derive(garde::Validate)]
//! struct Foo<'a> {
//! #[garde(length(min = 1))]
//! a: &'a str,
//!
//! #[garde(skip)]
//! b: &'a str, // this field will not be validated
//! }
//!
//! #[derive(garde::Validate)]
//! #[garde(allow_unvalidated)]
//! struct Bar<'a> {
//! #[garde(length(min = 1))]
//! a: &'a str,
//!
//! b: &'a str, // this field will not be validated
//! // note the lack of `#[garde(skip)]`
//! }
//! ```
//!
//! ### Inner type validation
//!
//! If you need to validate the "inner" type of a container, such as the `String` in `Vec<String>`, then use the `inner` modifier:
//!
//! ```rust
//! #[derive(garde::Validate)]
//! struct Test {
//! #[garde(
//! length(min = 1),
//! inner(ascii, length(min = 1)), // wrap the rule in `inner`
//! )]
//! items: Vec<String>,
//! }
//! ```
//!
//! The above type would fail validation if:
//! - the `Vec` is empty
//! - any of the inner `String` elements is empty
//! - any of the inner `String` elements contains non-ASCII characters
//!
//! ### Handling Option
//!
//! Every rule works on `Option<T>` fields. The field will only be validated if it is `Some`. If you additionally want to validate that the `Option<T>` field is `Some`, use the `required` rule:
//!
//! ```rust
//! #[derive(garde::Validate)]
//! struct Test {
//! #[garde(required, ascii, length(min = 1))]
//! value: Option<String>,
//! }
//! ```
//!
//! The above type would fail validation if:
//! - `value` is `None`
//! - the inner `value` is empty
//! - the inner `value` contains non-ASCII characters
//!
//! ### Custom validation
//!
//! Validation may be customized via the `custom` rule, and the `context` attribute.
//!
//! The context may be any type without generic parameters. By default, the context is `()`.
//!
//! ```rust,ignore
//! #[derive(garde::Validate)]
//! #[garde(context(PasswordContext))]
//! struct User {
//! #[garde(custom(is_strong_password))]
//! password: String,
//! }
//!
//! struct PasswordContext {
//! min_entropy: f32,
//! entropy: cracken::password_entropy::EntropyEstimator,
//! }
//!
//! fn is_strong_password(value: &str, context: &PasswordContext) -> garde::Result {
//! let bits = context.entropy.estimate_password_entropy(value.as_bytes())
//! .map(|e| e.mask_entropy)
//! .unwrap_or(0.0);
//! if bits < context.min_entropy {
//! return Err(garde::Error::new("password is not strong enough"));
//! }
//! Ok(())
//! }
//!
//! let ctx = PasswordContext { /* ... */ };
//! let user = User { /* ... */ };
//! user.validate(&ctx)?;
//! ```
//!
//! The validator function may accept the value as a reference to any type which it derefs to.
//! In the above example, it is possible to use `&str`, because `password` is a `String`, and `String` derefs to `&str`.
//!
//! ### Implementing rules
//!
//! Say you want to implement length checking for a custom string-like type.
//! To do this, you would implement the [`HasLength`][`crate::rules::length::HasLength`] trait for it.
//!
//! ```rust
//! #[repr(transparent)]
//! pub struct MyString(pub String);
//!
//! impl garde::rules::length::HasLength for MyString {
//! fn length(&self) -> usize {
//! self.0.chars().count()
//! }
//! }
//! #[derive(garde::Validate)]
//! struct Foo {
//! // Now the `length` check may be used with `MyString`
//! #[garde(length(min = 1, max = 1000))]
//! field: MyString,
//! }
//! ```
//!
//! Each rule comes with its own trait that may be implemented by custom types in your code.
//! They are all available under [`rules`][`crate::rules`].
//!
//! ### Implementing `Validate`
//!
//! In case you have a container type for which you'd like to support nested validation (using the `#[garde(dive)]` rule),
//! you may implement [`Validate`][`crate::Validate`] for it:
//!
//! ```rust
//! #[repr(transparent)]
//! struct MyVec<T>(Vec<T>);
//!
//! impl<T: garde::Validate> garde::Validate for MyVec<T> {
//! type Context = T::Context;
//!
//! fn validate(&self, ctx: &Self::Context) -> Result<(), garde::Errors> {
//! garde::Errors::list(|errors| {
//! for item in self.0.iter() {
//! errors.push(item.validate(ctx));
//! }
//! })
//! .finish()
//! }
//! }
//!
//! #[derive(garde::Validate)]
//! struct Foo {
//! #[garde(dive)]
//! field: MyVec<Bar>,
//! }
//!
//! #[derive(garde::Validate)]
//! struct Bar {
//! #[garde(range(min = 1, max = 10))]
//! value: u32,
//! }
//! ```
//!
//! To make implementing the trait easier, the [`Errors`][`crate::error::Errors`] type supports a nesting builders.
//! - For list-like or tuple-like data structures, use [`Errors::list`][`crate::error::Errors::list`],
//! and its `.push` method to attach nested [`Errors`][`crate::error::Errors`].
//! - For map-like data structures, use [`Errors::fields`][`crate::error::Errors::fields`],
//! and its `.insert` method to attach nested [`Errors`][`crate::error::Errors`].
//! - For a "flat" error list, use [`Errors::simple`][`crate::error::Errors::simple`],
//! and its `.push` method to attach individual errors.
//!
//! The [`ListErrorBuilder::push`][`crate::error::ListErrorBuilder::push`] and
//! [`FieldsErrorBuilder::insert`][`crate::error::FieldsErrorBuilder::insert`] methods
//! will ignore any errors which are empty (via [`Errors::is_empty`][`crate::error::Errors::is_empty`]).
//!
//! ### Integration with web frameworks
//!
//! - [`axum`](https://crates.io/crates/axum): https://crates.io/crates/axum_garde
//!
//! ### Feature flags
//!
//!
//! | name | description | extra dependencies |
//! |--------------------------|-----------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|
//! | `derive` | Enables the usage of the `derive(Validate)` macro | [`garde_derive`](https://crates.io/crates/garde_derive) |
//! | `url` | Validation of URLs via the `url` crate. | [`url`](https://crates.io/crates/url) |
//! | `email` | Validation of emails according to [HTML5](https://html.spec.whatwg.org/multipage/forms.html#valid-e-mail-address) | [`regex`](https://crates.io/crates/regex), [`once_cell`](https://crates.io/crates/once_cell) |
//! | `email-idna` | Support for [Internationalizing Domain Names for Applications](https://url.spec.whatwg.org/#idna) in email addresses | [`idna`](https://crates.io/crates/idna) |
//! | `regex` | Support for regular expressions in `pattern` via the `regex` crate | [`regex`](https://crates.io/crates/regex), [`once_cell`](https://crates.io/crates/once_cell) |
//! | `credit-card` | Validation of credit card numbers via the `card-validate` crate | [`card-validate`](https://crates.io/crates/card-validate) |
//! | `phone-number` | Validation of phone numbers via the `phonenumber` crate | [`phonenumber`](https://crates.io/crates/phonenumber) |
pub use ;
pub use Validate;
pub use ;
pub type Result = Result;