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 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
/*!  This crate provides an implementation of the `IRI` and `URI` specifications. It provides [`IRI`](struct.IRI.html) and [`IRIRef`](type.IRIRef.html) types that supports the semantics of the [IRI](https://en.wikipedia.org/wiki/Internationalized_Resource_Identifier), [URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier), [URL](https://en.wikipedia.org/wiki/URL), and [URN](https://en.wikipedia.org/wiki/Uniform_Resource_Name) specifications. # Examples The most common use is the parsing of an [`IRI`](struct.IRI.html) value from a string. ```rust use rdftk_iri::IRI; use std::str::FromStr; let result = IRI::from_str( "https://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top", ); ``` Once parsed it is easy to then extract the components of the [`IRI`](struct.IRI.html), as shown below. ```rust use rdftk_iri::IRI; use std::str::FromStr; let result = IRI::from_str( "https://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top", ); let iri = result.unwrap(); println!("scheme: {}", iri.scheme().as_ref().unwrap()); println!("user: {}", iri.authority().as_ref().unwrap().user_info().as_ref().unwrap().user_name()); println!("host: {}", iri.authority().as_ref().unwrap().host()); println!("port: {}", iri.authority().as_ref().unwrap().port().as_ref().unwrap()); println!("path: {}", iri.path()); println!("query: {}", iri.query().as_ref().unwrap()); println!("fragment: {}", iri.fragment().as_ref().unwrap()); ``` The previous code should result in the following: ```text scheme: https user: john.doe host: www.example.com port: 123 path: /forum/questions/ query: tag=networking&order=newest fragment: top ``` The `builder` module allows for more programmatic construction of [`IRI`](struct.IRI.html)s. ```rust use rdftk_iri::{IRI, Scheme}; use rdftk_iri::builder::IriBuilder; use rdftk_iri::error::Result as IriResult; use std::convert::TryInto; # fn main() -> rdftk_iri::error::Result<()> { let mut builder = IriBuilder::default(); let result: IriResult<IRI> = builder .scheme(&Scheme::https()) .user_name("john.doe") .host_str("www.example.com")? .port(123.into()) .path_str("/forum/questions/")? .query_str("tag=networking&order=newest")? .fragment_str("top")? .try_into(); # Ok(()) # } ``` Note also the use of `Scheme::https()`, both the [`Scheme`](struct.Scheme.html) and [`Port`](struct.Port.html) types include associated functions to construct well-known values. # Features The following features are present in this crate. * `builder` [default] -- include the [`builder`](builder/index.html) module, which in turn includes the [`IriBuilder`](builder/struct.IriBuilder.html) type. * `genid` [default] -- includes a constructor to create `"genid"` well-known IRI values. * `path_iri` [default] -- provides an implementation of `TryFrom<&PathBuf>` and `TryFrom<PathBuf>` for `IRI`. * `uuid_iri` [default] -- provides an implementation of `TryFrom<&Uuid>` and `TryFrom<Uuid>` for `IRI`. # Specifications 1. RFC-1630 [Universal Resource Identifiers in WWW](https://tools.ietf.org/html/rfc1630): A Unifying Syntax for the Expression of Names and Addresses of Objects on the Network as used in the World-Wide Web 1. RFC-1736 [Functional Recommendations for Internet Resource Locators](https://tools.ietf.org/html/rfc1736) 1. RFC-1737 [Functional Requirements for Uniform Resource Names](https://tools.ietf.org/html/rfc1737) 1. RFC-1738 [Uniform Resource Locators (URL)](https://tools.ietf.org/html/rfc1738) 1. RFC-1808 [Relative Uniform Resource Locators](https://tools.ietf.org/html/rfc1808) 1. RFC-2141 [URN Syntax](https://tools.ietf.org/html/rfc2141) 1. RFC-2396 [Uniform Resource Identifiers (URI): Generic Syntax](https://tools.ietf.org/html/rfc2396) 1. RFC-2616 [Hypertext Transfer Protocol -- HTTP/1.1](https://tools.ietf.org/html/rfc2616); §3.2 Uniform Resource Identifiers 1. RFC-2717 [Registration Procedures for URL Scheme Names](https://tools.ietf.org/html/rfc2717) 1. RFC-2732 [Format for Literal IPv6 Addresses in URL's](https://tools.ietf.org/html/rfc2732) 1. RFC-3305 Report from the Joint W3C/IETF URI Planning Interest Group: Uniform Resource Identifiers (URIs), URLs, and Uniform Resource Names (URNs): [Clarifications and Recommendations](https://tools.ietf.org/html/rfc3305) 1. RFC-3987 [Internationalized Resource Identifiers (IRIs)](https://tools.ietf.org/html/rfc3987) 1. RFC-6963 [A Uniform Resource Name (URN) Namespace for Examples](https://tools.ietf.org/html/rfc6963) 1. RFC-8141 [Uniform Resource Names (URNs)](https://tools.ietf.org/html/rfc8141) From RFC-2396, appendix A. _Collected BNF for URI_: ```text URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ] absoluteURI = scheme ":" ( hier_part | opaque_part ) relativeURI = ( net_path | abs_path | rel_path ) [ "?" query ] hier_part = ( net_path | abs_path ) [ "?" query ] opaque_part = uric_no_slash *uric uric_no_slash = unreserved | escaped | ";" | "?" | ":" | "@" | "&" | "=" | "+" | "$" | "," net_path = "//" authority [ abs_path ] abs_path = "/" path_segments rel_path = rel_segment [ abs_path ] rel_segment = 1*( unreserved | escaped | ";" | "@" | "&" | "=" | "+" | "$" | "," ) scheme = alpha *( alpha | digit | "+" | "-" | "." ) authority = server | reg_name reg_name = 1*( unreserved | escaped | "$" | "," | ";" | ":" | "@" | "&" | "=" | "+" ) server = [ [ userinfo "@" ] hostport ] userinfo = *( unreserved | escaped | ";" | ":" | "&" | "=" | "+" | "$" | "," ) hostport = host [ ":" port ] host = hostname | IPv4address hostname = *( domainlabel "." ) toplabel [ "." ] domainlabel = alphanum | alphanum *( alphanum | "-" ) alphanum toplabel = alpha | alpha *( alphanum | "-" ) alphanum IPv4address = 1*digit "." 1*digit "." 1*digit "." 1*digit port = *digit path = [ abs_path | opaque_part ] path_segments = segment *( "/" segment ) segment = *pchar *( ";" param ) param = *pchar pchar = unreserved | escaped | ":" | "@" | "&" | "=" | "+" | "$" | "," query = *uric fragment = *uric uric = reserved | unreserved | escaped reserved = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" | "$" | "," unreserved = alphanum | mark mark = "-" | "_" | "." | "!" | "~" | "*" | "'" | "(" | ")" escaped = "%" hex hex hex = digit | "A" | "B" | "C" | "D" | "E" | "F" | "a" | "b" | "c" | "d" | "e" | "f" alphanum = alpha | digit alpha = lowalpha | upalpha lowalpha = "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" upalpha = "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z" digit = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" ``` Also, _Excluded US-ASCII Characters_: ```text control = <US-ASCII coded characters 00-1F and 7F hexadecimal> space = <US-ASCII coded character 20 hexadecimal> delims = "<" | ">" | "#" | "%" | <"> unwise = "{" | "}" | "|" | "\" | "^" | "[" | "]" | "`" ``` To support IPv6 addresses the following changes were made in RFC-2732: ```text The following changes to the syntax in RFC 2396 are made: (1) change the 'host' non-terminal to add an IPv6 option: host = hostname | IPv4address | IPv6reference ipv6reference = "[" IPv6address "]" where IPv6address is defined as in RFC2373 [ARCH]. (2) Replace the definition of 'IPv4address' with that of RFC 2373, as it correctly defines an IPv4address as consisting of at most three decimal digits per segment. (3) Add "[" and "]" to the set of 'reserved' characters: reserved = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" | "$" | "," | "[" | "]" and remove them from the 'unwise' set: unwise = "{" | "}" | "|" | "\" | "^" | "`" ``` */ #![warn( // ---------- Stylistic future_incompatible, nonstandard_style, rust_2018_idioms, trivial_casts, trivial_numeric_casts, // ---------- Public missing_debug_implementations, missing_docs, unreachable_pub, // ---------- Unsafe unsafe_code, // ---------- Unused unused_extern_crates, unused_import_braces, unused_qualifications, unused_results, )] #[macro_use] extern crate error_chain; #[macro_use] extern crate lazy_static; use std::str::FromStr; // ------------------------------------------------------------------------------------------------ // Public Types // ------------------------------------------------------------------------------------------------ /// /// This trait is used on the [`IRI`](struct.IRI.html) and it's components to normalize their value /// according to the relevant RFC rules. /// /// 1. Normalization will ensure the correct case of certain components. /// 1. Normalization will removing any unnecessary "." and ".." segments from the path component of /// a hierarchical URI. /// pub trait Normalize { /// Return a normalized version of `self`. The default for normalization is to do nothing and /// return `self` unchanged. fn normalize(self) -> error::Result<Self> where Self: Sized, { Ok(self) } } /// /// Encode the corresponding type using percent-encoding rules. /// pub trait PercentEncoding { /// Construct a new value that has been percent encoded. If `for_uri` is true this method will /// also encode all non-ascii characters as a sequence of UTF-8 octets in percent encoded form. fn encode(&self, for_uri: bool) -> Self where Self: Sized; } /// /// This trait is implemented by most components to provide a way to determine whether a string /// value is valid. It can be assumed that the action is less expensive than performing the /// [`FromStr`](https://doc.rust-lang.org/std/str/trait.FromStr.html) conversion and checking it's /// result. /// pub trait ValidateStr: FromStr { /// Return `true` if the string is a valid representation of `Self`, else `false`. fn is_valid(s: &str) -> bool { Self::from_str(s).is_ok() } } // ------------------------------------------------------------------------------------------------ // Modules // ------------------------------------------------------------------------------------------------ mod pct_encoding; mod parse; // ------------------------------------------------------------------------------------------------ pub mod error; #[cfg(feature = "builder")] pub mod builder; #[doc(hidden)] pub mod scheme; pub use scheme::Scheme; #[doc(hidden)] pub mod authority; pub use authority::{Authority, Host, HostKind, Port, UserInfo}; #[doc(hidden)] pub mod path; pub use path::Path; #[doc(hidden)] pub mod query; pub use query::Query; #[doc(hidden)] pub mod fragment; pub use fragment::Fragment; #[allow(clippy::module_inception)] #[doc(hidden)] pub mod iri; pub use iri::{IRIRef, IRI};