Struct ValidationPattern 

pub struct ValidationPattern {
    pub pattern: String,
    pub description: String,
    pub examples: Option<Vec<String>>,
}

Common validation patterns for field validation

Examples

use reinhardt_rest::metadata::ValidationPattern;

let pattern = ValidationPattern::email();
assert!(pattern.is_valid("user@example.com"));
assert!(!pattern.is_valid("invalid-email"));

Fields

pattern: String

The regular expression pattern

description: String

Description of what the pattern validates

examples: Option<Vec<String>>

Example values that match this pattern

Implementations

impl ValidationPattern

pub fn new( pattern: impl Into<String>, description: impl Into<String>, ) -> ValidationPattern

Available on native and crate feature rest only.

Creates a new validation pattern

Examples

use reinhardt_rest::metadata::ValidationPattern;

let pattern = ValidationPattern::new(
    r"^\d{3}-\d{4}$",
    "Phone number format (XXX-XXXX)"
);
assert_eq!(pattern.pattern, r"^\d{3}-\d{4}$");

pub fn with_examples( pattern: impl Into<String>, description: impl Into<String>, examples: Vec<impl Into<String>>, ) -> ValidationPattern

Available on native and crate feature rest only.

Creates a new validation pattern with examples

Examples

use reinhardt_rest::metadata::ValidationPattern;

let pattern = ValidationPattern::with_examples(
    r"^\d{3}-\d{4}$",
    "Phone number format",
    vec!["123-4567", "555-0100"]
);
assert_eq!(pattern.examples.as_ref().unwrap().len(), 2);

pub fn email() -> ValidationPattern

Available on native and crate feature rest only.

Email address pattern

Examples

use reinhardt_rest::metadata::ValidationPattern;

let pattern = ValidationPattern::email();
assert!(pattern.is_valid("user@example.com"));
assert!(pattern.is_valid("test.user+tag@example.co.uk"));
assert!(!pattern.is_valid("invalid-email"));
assert!(!pattern.is_valid("@example.com"));

pub fn url() -> ValidationPattern

Available on native and crate feature rest only.

URL pattern

Examples

use reinhardt_rest::metadata::ValidationPattern;

let pattern = ValidationPattern::url();
assert!(pattern.is_valid("https://example.com"));
assert!(pattern.is_valid("http://example.com/path"));
assert!(!pattern.is_valid("not-a-url"));

pub fn uuid() -> ValidationPattern

Available on native and crate feature rest only.

UUID pattern (version 4)

Examples

use reinhardt_rest::metadata::ValidationPattern;

let pattern = ValidationPattern::uuid();
assert!(pattern.is_valid("123e4567-e89b-12d3-a456-426614174000"));
assert!(!pattern.is_valid("not-a-uuid"));

pub fn alphanumeric() -> ValidationPattern

Available on native and crate feature rest only.

Alphanumeric pattern (letters and numbers only)

Examples

use reinhardt_rest::metadata::ValidationPattern;

let pattern = ValidationPattern::alphanumeric();
assert!(pattern.is_valid("abc123"));
assert!(pattern.is_valid("TestUser123"));
assert!(!pattern.is_valid("user@name"));
assert!(!pattern.is_valid("user-name"));

pub fn slug() -> ValidationPattern

Available on native and crate feature rest only.

Slug pattern (URL-friendly identifier)

Examples

use reinhardt_rest::metadata::ValidationPattern;

let pattern = ValidationPattern::slug();
assert!(pattern.is_valid("my-blog-post"));
assert!(pattern.is_valid("article-123"));
assert!(!pattern.is_valid("My Blog Post"));
assert!(!pattern.is_valid("article_123"));

pub fn phone() -> ValidationPattern

Available on native and crate feature rest only.

Phone number pattern (international format)

Examples

use reinhardt_rest::metadata::ValidationPattern;

let pattern = ValidationPattern::phone();
assert!(pattern.is_valid("+1-234-567-8900"));
assert!(pattern.is_valid("+81-90-1234-5678"));
assert!(!pattern.is_valid("123-456-7890")); // Missing country code

pub fn hex_color() -> ValidationPattern

Available on native and crate feature rest only.

Hex color pattern

Examples

use reinhardt_rest::metadata::ValidationPattern;

let pattern = ValidationPattern::hex_color();
assert!(pattern.is_valid("#FF5733"));
assert!(pattern.is_valid("#fff"));
assert!(!pattern.is_valid("FF5733")); // Missing #
assert!(!pattern.is_valid("#GG5733")); // Invalid hex

pub fn ipv4() -> ValidationPattern

Available on native and crate feature rest only.

IP address pattern (IPv4)

Examples

use reinhardt_rest::metadata::ValidationPattern;

let pattern = ValidationPattern::ipv4();
assert!(pattern.is_valid("192.168.1.1"));
assert!(pattern.is_valid("10.0.0.1"));
assert!(!pattern.is_valid("256.1.1.1")); // Invalid range
assert!(!pattern.is_valid("192.168.1")); // Incomplete

pub fn date() -> ValidationPattern

Available on native and crate feature rest only.

Date pattern (YYYY-MM-DD)

Note: This pattern only validates the format, not the validity of the date itself. For example, it will accept “2023-13-01” (invalid month) or “2023-02-30” (invalid day). Use a proper date parsing library for full validation.

Examples

use reinhardt_rest::metadata::ValidationPattern;

let pattern = ValidationPattern::date();
assert!(pattern.is_valid("2023-12-25"));
assert!(pattern.is_valid("2024-01-01"));
assert!(!pattern.is_valid("23-12-25")); // Wrong format
assert!(!pattern.is_valid("2023/12/25")); // Wrong separator

pub fn time() -> ValidationPattern

Available on native and crate feature rest only.

Time pattern (HH:MM:SS)

Examples

use reinhardt_rest::metadata::ValidationPattern;

let pattern = ValidationPattern::time();
assert!(pattern.is_valid("14:30:00"));
assert!(pattern.is_valid("09:05:30"));
assert!(!pattern.is_valid("25:00:00")); // Invalid hour
assert!(!pattern.is_valid("14:30")); // Missing seconds

pub fn is_valid(&self, value: &str) -> bool

Available on native and crate feature rest only.

Validates if a value matches this pattern

Examples

use reinhardt_rest::metadata::ValidationPattern;

let pattern = ValidationPattern::email();
assert!(pattern.is_valid("user@example.com"));
assert!(!pattern.is_valid("invalid"));

pub fn as_openapi_pattern(&self) -> &str

Available on native and crate feature rest only.

Returns the pattern as a string for use in OpenAPI schemas

Examples

use reinhardt_rest::metadata::ValidationPattern;

let pattern = ValidationPattern::email();
assert!(pattern.as_openapi_pattern().starts_with('^'));

Trait Implementations

impl Clone for ValidationPattern

fn clone(&self) -> ValidationPattern

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ValidationPattern

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ValidationPattern

fn deserialize<__D>( __deserializer: __D, ) -> Result<ValidationPattern, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ValidationPattern

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.