iref 4.0.0

Uniform & Internationalized Resource Identifiers (URIs/IRIs), borrowed and owned.
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

use core::ops::Deref;

/// URI path segment.
#[derive(static_automata::Validate, str_newtype::StrNewType)]
#[automaton(super::super::grammar::Segment)]
#[newtype(
	no_deref,
	ord([u8], &[u8], str, &str, pct_str::PctStr, &pct_str::PctStr)
)]
#[cfg_attr(
	feature = "std",
	newtype(ord(Vec<u8>, String, pct_str::PctString), owned(SegmentBuf, derive(PartialEq, Eq, PartialOrd, Ord, Hash)))
)]
#[cfg_attr(feature = "serde", newtype(serde))]
pub struct Segment(str);

impl Segment {
	/// Empty segment.
	pub const EMPTY: &Self = unsafe { Segment::new_unchecked("") };

	/// Current directory (`.`) segment.
	pub const CURRENT: &Self = unsafe { Segment::new_unchecked(".") };

	/// Parent directory (`..`) segment.
	pub const PARENT: &Self = unsafe { Segment::new_unchecked("..") };

	/// Returns the segment as a percent-encoded string slice.
	#[inline]
	pub fn as_pct_str(&self) -> &pct_str::PctStr {
		unsafe { pct_str::PctStr::new_unchecked(self.as_bytes()) }
	}

	/// Segment byte length.
	pub fn len(&self) -> usize {
		self.as_bytes().len()
	}

	/// Whether or not the segment is empty.
	pub fn is_empty(&self) -> bool {
		self.as_bytes().is_empty()
	}

	/// Checks if this segment looks like a scheme.
	///
	/// Returns `true` if it is of the form `prefix:suffix` where `prefix` is a
	/// valid scheme, of `false` otherwise.
	pub fn looks_like_scheme(&self) -> bool {
		crate::common::parse::looks_like_scheme(self.as_bytes())
	}
}

impl Deref for Segment {
	type Target = pct_str::PctStr;

	fn deref(&self) -> &Self::Target {
		self.as_pct_str()
	}
}

impl PartialEq for Segment {
	fn eq(&self, other: &Self) -> bool {
		self.as_pct_str() == other.as_pct_str()
	}
}

impl Eq for Segment {}

impl PartialOrd for Segment {
	fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
		Some(self.cmp(other))
	}
}

impl Ord for Segment {
	fn cmp(&self, other: &Self) -> core::cmp::Ordering {
		self.as_pct_str().cmp(other.as_pct_str())
	}
}

impl core::hash::Hash for Segment {
	fn hash<H: core::hash::Hasher>(&self, state: &mut H) {
		self.as_pct_str().hash(state)
	}
}

/// Parses a URI path [`Segment`] at compile time.
#[macro_export]
macro_rules! segment {
	($value:literal) => {
		match $crate::uri::Segment::from_str($value) {
			Ok(value) => value,
			Err(_) => panic!("invalid URI path segment"),
		}
	};
}