A Rust validation library

• Basic usage example
• Validation rules
• Length modes
• Inner type validation
• Newtypes
• Handling Option
• Custom validation
• Context/Self access
• Implementing rules
• Implementing Validate
• Rule adapters
• Integration with web frameworks
• Feature flags
• Why garde?

To get started, install garde:

And attach the Validate derive to your type. garde will generate an implementation of the Validate trait for you,
allowing you to call the validate method.

Here’s what that looks like in full:

Garde can also validate enums:

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}");
}

Additional notes:

• required is only available for Option fields.
• dive accepts an optional context: #[garde(dive(self.other_field))]
• The argument for length is explained here
• For length and range:
  • If equal is defined, min and max must be omitted.
  • Assuming equal is omitted, either min or max may be omitted, but not both.
  • min and max use an inclusive upper bound (min..=max). Setting min == max is equivalent to using equal.
• For contains, prefix, and suffix, the pattern must be a string literal, because the Pattern API is currently unstable.
• 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:

Tags: gardepowerful

0Likes

Written by

HackTech

View all posts by HackTech