urn 0.7.0

A crate for handling URNs (Unique Resource Names)
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176

use crate::{Error, Result, UrnSlice};
#[cfg(all(not(feature = "std"), feature = "alloc"))]
use alloc::{borrow::ToOwned, string::String};
use core::{
    borrow::{Borrow, BorrowMut},
    fmt,
    ops::{Deref, DerefMut},
    str::FromStr,
};

/// An owned RFC2141/8141 URN (Uniform Resource Name).
///
/// **Note:** the equivalence checks are done
/// [according to the specification](https://www.rfc-editor.org/rfc/rfc8141.html#section-3),
/// only taking the NID and NSS into account! If you need exact equivalence checks, consider
/// comparing using `Urn::as_str()` as the key. Some namespaces may define additional lexical
/// equivalence rules, these aren't accounted for in this implementation (Meaning there might be
/// false negatives for some namespaces). There will, however, be no false positives.
///
/// `FromStr` requires a single allocation, but `TryFrom<String>` doesn't, so prefer `TryFrom` when
/// possible.
#[repr(transparent)]
#[derive(PartialEq, Eq, Hash)]
pub struct Urn(pub(crate) UrnSlice<'static>);

impl<'a> Borrow<UrnSlice<'a>> for Urn {
    fn borrow(&self) -> &UrnSlice<'a> {
        &self.0
    }
}

impl BorrowMut<UrnSlice<'static>> for Urn {
    fn borrow_mut(&mut self) -> &mut UrnSlice<'static> {
        &mut self.0
    }
}

impl<'a> From<UrnSlice<'a>> for Urn {
    fn from(value: UrnSlice<'a>) -> Self {
        use crate::TriCow;
        Self(UrnSlice {
            urn: match value.urn {
                TriCow::Owned(s) => TriCow::Owned(s),
                TriCow::Borrowed(s) => TriCow::Owned(s.to_owned()),
                TriCow::MutBorrowed(s) => TriCow::Owned(s.to_owned()),
            },
            nid_len: value.nid_len,
            nss_len: value.nss_len,
            q_component_len: value.q_component_len,
            r_component_len: value.r_component_len,
        })
    }
}

impl<'a> From<&UrnSlice<'a>> for Urn {
    fn from(value: &UrnSlice<'a>) -> Self {
        use crate::TriCow;
        Self(UrnSlice {
            urn: match &value.urn {
                TriCow::Owned(s) => TriCow::Owned(s.clone()),
                TriCow::Borrowed(s) => TriCow::Owned((*s).to_owned()),
                TriCow::MutBorrowed(s) => TriCow::Owned((*s).to_owned()),
            },
            nid_len: value.nid_len,
            nss_len: value.nss_len,
            q_component_len: value.q_component_len,
            r_component_len: value.r_component_len,
        })
    }
}

impl<'a> From<&mut UrnSlice<'a>> for Urn {
    fn from(value: &mut UrnSlice<'a>) -> Self {
        use crate::TriCow;
        Self(UrnSlice {
            urn: match &value.urn {
                TriCow::Owned(s) => TriCow::Owned(s.clone()),
                TriCow::Borrowed(s) => TriCow::Owned((*s).to_owned()),
                TriCow::MutBorrowed(s) => TriCow::Owned((*s).to_owned()),
            },
            nid_len: value.nid_len,
            nss_len: value.nss_len,
            q_component_len: value.q_component_len,
            r_component_len: value.r_component_len,
        })
    }
}

impl Clone for Urn {
    fn clone(&self) -> Self {
        self.0.to_owned()
    }
}

impl fmt::Debug for Urn {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Urn({})", self.as_str())
    }
}

impl Deref for Urn {
    type Target = UrnSlice<'static>;
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl DerefMut for Urn {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

impl<'a> AsRef<UrnSlice<'a>> for Urn {
    fn as_ref(&self) -> &UrnSlice<'a> {
        &self.0
    }
}

impl AsMut<UrnSlice<'static>> for Urn {
    fn as_mut(&mut self) -> &mut UrnSlice<'static> {
        &mut self.0
    }
}

impl<'a> PartialEq<UrnSlice<'a>> for Urn {
    fn eq(&self, other: &UrnSlice<'a>) -> bool {
        &self.0 == other
    }
}

impl AsRef<[u8]> for Urn {
    fn as_ref(&self) -> &[u8] {
        self.0.as_ref()
    }
}

impl AsRef<str> for Urn {
    fn as_ref(&self) -> &str {
        self.0.as_ref()
    }
}

impl fmt::Display for Urn {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
        self.0.fmt(f)
    }
}

impl FromStr for Urn {
    type Err = Error;
    fn from_str(s: &str) -> Result<Self> {
        Ok(Self(UrnSlice::from_str(s)?))
    }
}

impl<'a> TryFrom<&'a str> for Urn {
    type Error = Error;
    fn try_from(value: &'a str) -> Result<Self> {
        Ok(Self(UrnSlice::try_from(value.to_owned())?))
    }
}

impl<'a> TryFrom<&'a mut str> for Urn {
    type Error = Error;
    fn try_from(value: &'a mut str) -> Result<Self> {
        Ok(Self(UrnSlice::try_from(value.to_owned())?))
    }
}

impl TryFrom<String> for Urn {
    type Error = Error;
    fn try_from(value: String) -> Result<Self> {
        Ok(Self(UrnSlice::try_from(value)?))
    }
}