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

//! URI and IRI types.
//!
//! # IRI types
//!
//! Defined in [RFC 3987](https://tools.ietf.org/html/rfc3987).
//!
//! a URI (defined in [RFC 3986](https://tools.ietf.org/html/rfc3986)) is also
//! an IRI.
//!
//! ```text
//! IRI           = scheme ":" ihier-part [ "?" iquery ] [ "#" ifragment ]
//! IRI-reference = IRI / irelative-ref
//! absolute-IRI  = scheme ":" ihier-part [ "?" iquery ]
//! irelative-ref = irelative-part [ "?" iquery ] [ "#" ifragment ]
//!     (`irelative-part` is roughly same as `ihier-part`.)
//! ```
//!
//! Hierarchy:
//!
//! ```text
//! IriReferenceStr
//! |-- IriStr
//! |   `-- AbsoluteIriStr
//! `-- RelativeIriStr
//! ```
//!
//! Therefore, the conversions below are safe and cheap:
//!
//! * `IriStr -> IriReferenceStr`
//! * `AbsoluteIriStr -> IriStr`
//! * `AbsoluteIriStr -> IriReferenceStr`
//! * `RelativeIriStr -> IriReferenceStr`
//!
//! For safely convertible types (consider `FooStr -> BarStr` is safe), traits
//! below are implemented:
//!
//! * `AsRef<BarStr> for FooStr`
//! * `AsRef<BarStr> for FooString`
//! * `From<FooString> for BarString`
//! * `PartialEq<FooStr> for BarStr` and lots of impls like that
//!     + `PartialEq` and `ParitalOrd`.
//!     + Slice, owned, `Cow`, reference, etc...
//!
//! # URI types
//!
//! Currently not implemented :-P.

pub use self::iri::{
    AbsoluteIriStr, AbsoluteIriString, IriCreationError, IriFragmentStr, IriFragmentString,
    IriReferenceStr, IriReferenceString, IriStr, IriString, RelativeIriStr, RelativeIriString,
};

#[macro_use]
mod macros;

mod iri;

/// Error on conversion into an IRI type.
#[deprecated(since = "0.2.1", note = "Renamed to `IriCreationError`")]
pub type CreationError<T> = IriCreationError<T>;