wary 0.3.1

A simple validation and transformation library.
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
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

//! Rule for URL validation.
//!
//! See [`UrlRule`] for more information.

use crate::toolbox::rule::*;

#[doc(hidden)]
pub type Rule = UrlRule;

#[derive(Debug, thiserror::Error, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize), serde(untagged))]
pub enum Error {
	#[error("empty host")]
	EmptyHost,
	#[error("invalid international domain name")]
	IdnaError,
	#[error("invalid port number")]
	InvalidPort,
	#[error("invalid IPv4 address")]
	InvalidIpv4Address,
	#[error("invalid IPv6 address")]
	InvalidIpv6Address,
	#[error("invalid domain character")]
	InvalidDomainCharacter,
	#[error("relative URL without a base")]
	RelativeUrlWithoutBase,
	#[error("relative URL with a cannot-be-a-base base")]
	RelativeUrlWithCannotBeABaseBase,
	#[error("a cannot-be-a-base URL doesn’t have a host to set")]
	SetHostOnCannotBeABaseUrl,
	#[error("URLs more than 4 GB are not supported")]
	Overflow,
	#[error("unknown URL error")]
	Other,
}

impl Error {
	#[must_use]
	pub(crate) fn code(&self) -> &'static str {
		match self {
			Self::EmptyHost => "empty_host",
			Self::IdnaError => "idna_error",
			Self::InvalidPort => "invalid_port",
			Self::InvalidIpv4Address => "invalid_ipv4_address",
			Self::InvalidIpv6Address => "invalid_ipv6_address",
			Self::InvalidDomainCharacter => "invalid_domain_character",
			Self::RelativeUrlWithoutBase => "relative_url_without_base",
			Self::RelativeUrlWithCannotBeABaseBase => "relative_url_with_cannot_be_a_base_base",
			Self::SetHostOnCannotBeABaseUrl => "set_host_on_cannot_be_a_base_url",
			Self::Overflow => "overflow",
			Self::Other => "other",
		}
	}

	pub(crate) fn message(&self) -> &'static str {
		match self {
			Self::EmptyHost => "empty host",
			Self::IdnaError => "invalid international domain name",
			Self::InvalidPort => "invalid port number",
			Self::InvalidIpv4Address => "invalid IPv4 address",
			Self::InvalidIpv6Address => "invalid IPv6 address",
			Self::InvalidDomainCharacter => "invalid domain character",
			Self::RelativeUrlWithoutBase => "relative URL without a base",
			Self::RelativeUrlWithCannotBeABaseBase => "relative URL with a cannot-be-a-base base",
			Self::SetHostOnCannotBeABaseUrl => "a cannot-be-a-base URL doesn’t have a host to set",
			Self::Overflow => "URLs more than 4 GB are not supported",
			Self::Other => "unknown URL error",
		}
	}
}

impl From<url::ParseError> for Error {
	fn from(value: url::ParseError) -> Self {
		match value {
			url::ParseError::EmptyHost => Self::EmptyHost,
			url::ParseError::IdnaError => Self::IdnaError,
			url::ParseError::InvalidPort => Self::InvalidPort,
			url::ParseError::InvalidIpv4Address => Self::InvalidIpv4Address,
			url::ParseError::InvalidIpv6Address => Self::InvalidIpv6Address,
			url::ParseError::InvalidDomainCharacter => Self::InvalidDomainCharacter,
			url::ParseError::RelativeUrlWithoutBase => Self::RelativeUrlWithoutBase,
			url::ParseError::RelativeUrlWithCannotBeABaseBase => Self::RelativeUrlWithCannotBeABaseBase,
			url::ParseError::SetHostOnCannotBeABaseUrl => Self::SetHostOnCannotBeABaseUrl,
			url::ParseError::Overflow => Self::Overflow,
			_ => Self::Other,
		}
	}
}

/// Rule for URL validation.
///
/// # Example
///
/// ```
/// use wary::{Wary, Validate};
///
/// #[derive(Wary)]
/// struct Image {
///   label: String,
///   #[validate(url)]
///   src: String,
/// }
///
/// let image = Image {
///   label: "My cat".into(),
///   src: "https://example.com/cat.jpg".into(),
/// };
///
/// assert!(image.validate(&()).is_ok());
///
/// let image = Image {
///   label: "My cat".into(),
///   src: "hello".into(),
/// };
///
/// assert!(image.validate(&()).is_err());
/// ```
pub struct UrlRule;

impl UrlRule {
	#[must_use]
	#[inline]
	pub const fn new() -> Self {
		Self
	}
}

impl<I: ?Sized> crate::Rule<I> for UrlRule
where
	I: AsRef<str>,
{
	type Context = ();

	#[inline]
	fn validate(&self, _ctx: &Self::Context, item: &I) -> Result<()> {
		url::Url::parse(item.as_ref()).map_err(Error::from)?;
		Ok(())
	}
}

#[cfg(test)]
mod test {
	use super::UrlRule;
	use crate::toolbox::test::*;

	const rule: UrlRule = UrlRule::new();

	#[test]
	fn test_url() {
		assert!(rule.validate(&(), "https://example.com").is_ok());
		assert!(rule.validate(&(), "hello").is_err());
	}
}