valistr 0.2.0

Creating immutable string wrapper types with values validated with regexes.
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

//! This crate provides a procedural macro to create immutable string wrapper types with values validated with regexes.
//!
//! ## Usage
//!
//! To use this crate, use `#[valistr(regex)]` attribute on a unit struct. The regex should be a string literal. Anchors `^` and `$` are automatically added to the regex if they are not present.
//!
//! The following traits are implemented for the struct:
//! - `Deref<Target = String>`
//! - `DerefMut<Target = String>`
//! - `Debug`
//! - `Display`
//! - `TryFrom<&str>`
//! - `TryFrom<String>`
//!
//! The following methods are generated for the struct:
//! - `fn new(value: impl Into<String>) -> Option<Self>`
//! - `fn validator() -> &'static Regex`
//! - `fn get_<name>(&self) -> Option<&str>` for each named capture group `<name>` in the regex.
//!   - The method is generated only if the name matches `[a-z][a-z0-9_]*`. This constraint guarantees the generated method name is a valid and clean Rust identifier.
//!
//! ## Example
//!
//! ```rust
//! use valistr::valistr;
//!
//! #[valistr("[A-Za-z]*")]
//! struct AsciiLetters;
//!
//! assert!(AsciiLetters::new("Hello").is_some());
//! assert!(AsciiLetters::new("Hello, world!").is_none());
//! ```
#![no_std]

pub use valistr_proc_macro::valistr;

#[doc(hidden)]
/// Re-export the `regex` crate.
pub mod reexport {
    pub use regex;
}