[][src]Struct iri_string::types::IriStr

#[repr(transparent)]
pub struct IriStr(_);

A borrowed string of an absolute IRI possibly with fragment part.

This corresponds to IRI rule in RFC 3987. This is scheme ":" ihier-part [ "?" iquery ] [ "#" ifragment ]. In other words, this is AbsoluteIriStr with fragment part allowed.

Methods

impl IriStr[src]

pub fn new(s: &str) -> Result<&Self, Error>[src]

Creates a new &IriStr.

Examples

assert!(IriStr::new("https://user:pass@example.com:8080").is_ok());
assert!(IriStr::new("https://example.com/").is_ok());
assert!(IriStr::new("https://example.com/foo?bar=baz").is_ok());
assert!(IriStr::new("https://example.com/foo?bar=baz#qux").is_ok());
assert!(IriStr::new("foo:bar").is_ok());
assert!(IriStr::new("foo:").is_ok());
// `foo://.../` below are all allowed. See the crate documentation for detail.
assert!(IriStr::new("foo:/").is_ok());
assert!(IriStr::new("foo://").is_ok());
assert!(IriStr::new("foo:///").is_ok());
assert!(IriStr::new("foo:////").is_ok());
assert!(IriStr::new("foo://///").is_ok());

// Relative IRI is not allowed.
assert!(IriStr::new("foo/bar").is_err());
assert!(IriStr::new("/foo/bar").is_err());
assert!(IriStr::new("//foo/bar").is_err());
assert!(IriStr::new("#foo").is_err());

pub fn to_absolute_and_fragment(
    &self
) -> (&AbsoluteIriStr, Option<&IriFragmentStr>)
[src]

Splits the IRI into absolute IRI part and fragment part.

A leading # character is truncated if the fragment part exists.

Examples

let iri = IriStr::new("foo://bar/baz?qux=quux#corge")?;
let (absolute, fragment) = iri.to_absolute_and_fragment();
let fragment_expected = IriFragmentStr::new("corge")?;
assert_eq!(absolute, "foo://bar/baz?qux=quux");
assert_eq!(fragment, Some(fragment_expected));
let iri = IriStr::new("foo://bar/baz?qux=quux#")?;
let (absolute, fragment) = iri.to_absolute_and_fragment();
let fragment_expected = IriFragmentStr::new("")?;
assert_eq!(absolute, "foo://bar/baz?qux=quux");
assert_eq!(fragment, Some(fragment_expected));
let iri = IriStr::new("foo://bar/baz?qux=quux")?;
let (absolute, fragment) = iri.to_absolute_and_fragment();
assert_eq!(absolute, "foo://bar/baz?qux=quux");
assert_eq!(fragment, None);

pub fn to_absolute(&self) -> &AbsoluteIriStr[src]

Strips the fragment part if exists, and returns &AbsoluteIriStr.

Examples

let iri = IriStr::new("foo://bar/baz?qux=quux#corge")?;
assert_eq!(iri.to_absolute(), "foo://bar/baz?qux=quux");
let iri = IriStr::new("foo://bar/baz?qux=quux")?;
assert_eq!(iri.to_absolute(), "foo://bar/baz?qux=quux");

pub fn as_str(&self) -> &str[src]

Returns &str.

Methods from Deref<Target = IriReferenceStr>

pub fn to_iri(&self) -> Result<&IriStr, &RelativeIriStr>[src]

Returns the string as &IriStr, if it is valid as an IRI.

If it is not an IRI, then &RelativeIriStr is returned as Err(_).

pub fn to_relative_iri(&self) -> Result<&RelativeIriStr, &IriStr>[src]

Returns the string as &RelativeIriStr, if it is valid as an IRI.

If it is not an IRI, then &IriStr is returned as Err(_).

pub fn resolve_against(&self, base: &AbsoluteIriStr) -> IriString[src]

Returns resolved IRI against the given base IRI, using strict resolver.

About reference resolution output example, see RFC 3986 section 5.4.

About resolver strictness, see RFC 3986 section 5.4.2:

Some parsers allow the scheme name to be present in a relative reference if it is the same as the base URI scheme. This is considered to be a loophole in prior specifications of partial URI RFC1630. Its use should be avoided but is allowed for backward compatibility.

--- https://tools.ietf.org/html/rfc3986#section-5.4.2

Usual users will want to use strict resolver.

pub fn resolve(&self, base: &AbsoluteIriStr) -> IriString[src]

Deprecated since 0.2.2:

Renamed to resolve_against()

Returns resolved IRI against the given base IRI, using strict resolver.

pub fn fragment(&self) -> Option<&IriFragmentStr>[src]

Returns the fragment part if exists.

A leading # character is truncated if the fragment part exists.

Examples

let iri = IriReferenceStr::new("foo://bar/baz?qux=quux#corge")?;
let fragment = IriFragmentStr::new("corge")?;
assert_eq!(iri.fragment(), Some(fragment));
let iri = IriReferenceStr::new("foo://bar/baz?qux=quux#")?;
let fragment = IriFragmentStr::new("")?;
assert_eq!(iri.fragment(), Some(fragment));
let iri = IriReferenceStr::new("foo://bar/baz?qux=quux")?;
assert_eq!(iri.fragment(), None);
let iri = IriReferenceStr::new("#foo")?;
let fragment = IriFragmentStr::new("foo")?;
assert_eq!(iri.fragment(), Some(fragment));
let iri = IriReferenceStr::new("")?;
assert_eq!(iri.fragment(), None);

pub fn as_str(&self) -> &str[src]

Returns &str.

Trait Implementations

impl AsRef<IriStr> for AbsoluteIriString[src]

impl AsRef<IriStr> for AbsoluteIriStr[src]

impl AsRef<str> for IriStr where
    str: AsRef<str>, 

impl AsRef<IriStr> for IriStr

impl AsRef<IriStr> for IriString

impl AsRef<IriReferenceStr> for IriStr[src]

impl<'a> From<&'a AbsoluteIriStr> for &'a IriStr[src]

impl<'a> From<&'a IriStr> for Arc<IriStr> where
    Arc<str>: From<&'a str>, 

impl<'a> From<&'a IriStr> for Box<IriStr> where
    Box<str>: From<&'a str>, 

impl<'a> From<&'a IriStr> for Rc<IriStr> where
    Rc<str>: From<&'a str>, 

impl<'a> From<&'a IriStr> for &'a IriReferenceStr[src]

impl<'a> Default for &'a IriStr where
    &'a str: Default

impl Eq for IriStr[src]

impl Ord for IriStr[src]

impl PartialEq<IriStr> for AbsoluteIriString[src]

impl PartialEq<AbsoluteIriString> for IriStr[src]

impl<'_> PartialEq<&'_ IriStr> for AbsoluteIriString[src]

impl<'_> PartialEq<AbsoluteIriString> for &'_ IriStr[src]

impl PartialEq<IriStr> for AbsoluteIriStr[src]

impl PartialEq<AbsoluteIriStr> for IriStr[src]

impl<'_> PartialEq<&'_ IriStr> for AbsoluteIriStr[src]

impl<'_> PartialEq<AbsoluteIriStr> for &'_ IriStr[src]

impl<'_> PartialEq<IriStr> for &'_ AbsoluteIriStr[src]

impl<'_> PartialEq<&'_ AbsoluteIriStr> for IriStr[src]

impl PartialEq<IriStr> for IriStr[src]

impl<'_> PartialEq<&'_ IriStr> for IriStr

impl<'_> PartialEq<IriStr> for &'_ IriStr

impl<'_> PartialEq<Cow<'_, IriStr>> for IriStr

impl<'_> PartialEq<IriStr> for Cow<'_, IriStr>

impl PartialEq<str> for IriStr

impl PartialEq<IriStr> for str

impl<'_> PartialEq<&'_ str> for IriStr

impl<'_> PartialEq<IriStr> for &'_ str

impl<'_> PartialEq<str> for &'_ IriStr

impl<'_> PartialEq<&'_ IriStr> for str

impl<'_> PartialEq<Cow<'_, str>> for IriStr

impl<'_> PartialEq<IriStr> for Cow<'_, str>

impl<'_, '_> PartialEq<Cow<'_, str>> for &'_ IriStr

impl<'_, '_> PartialEq<&'_ IriStr> for Cow<'_, str>

impl PartialEq<IriStr> for IriString

impl PartialEq<IriString> for IriStr

impl<'_> PartialEq<&'_ IriStr> for IriString

impl<'_> PartialEq<IriString> for &'_ IriStr

impl PartialEq<IriReferenceStr> for IriStr[src]

impl PartialEq<IriStr> for IriReferenceStr[src]

impl<'_> PartialEq<&'_ IriReferenceStr> for IriStr[src]

impl<'_> PartialEq<IriStr> for &'_ IriReferenceStr[src]

impl PartialEq<IriReferenceString> for IriStr[src]

impl PartialEq<IriStr> for IriReferenceString[src]

impl<'_> PartialEq<Cow<'_, IriReferenceStr>> for IriStr[src]

impl<'_> PartialEq<IriStr> for Cow<'_, IriReferenceStr>[src]

impl<'_> PartialEq<IriReferenceStr> for &'_ IriStr[src]

impl<'_> PartialEq<&'_ IriStr> for IriReferenceStr[src]

impl<'_> PartialEq<IriReferenceString> for &'_ IriStr[src]

impl<'_> PartialEq<&'_ IriStr> for IriReferenceString[src]

impl<'_, '_> PartialEq<Cow<'_, IriReferenceStr>> for &'_ IriStr[src]

impl<'_, '_> PartialEq<&'_ IriStr> for Cow<'_, IriReferenceStr>[src]

impl PartialOrd<IriStr> for AbsoluteIriString[src]

impl PartialOrd<AbsoluteIriString> for IriStr[src]

impl<'_> PartialOrd<&'_ IriStr> for AbsoluteIriString[src]

impl<'_> PartialOrd<AbsoluteIriString> for &'_ IriStr[src]

impl PartialOrd<IriStr> for AbsoluteIriStr[src]

impl PartialOrd<AbsoluteIriStr> for IriStr[src]

impl<'_> PartialOrd<&'_ IriStr> for AbsoluteIriStr[src]

impl<'_> PartialOrd<AbsoluteIriStr> for &'_ IriStr[src]

impl<'_> PartialOrd<IriStr> for &'_ AbsoluteIriStr[src]

impl<'_> PartialOrd<&'_ AbsoluteIriStr> for IriStr[src]

impl PartialOrd<IriStr> for IriStr[src]

impl<'_> PartialOrd<&'_ IriStr> for IriStr

impl<'_> PartialOrd<IriStr> for &'_ IriStr

impl<'_> PartialOrd<Cow<'_, IriStr>> for IriStr

impl<'_> PartialOrd<IriStr> for Cow<'_, IriStr>

impl PartialOrd<str> for IriStr

impl PartialOrd<IriStr> for str

impl<'_> PartialOrd<&'_ str> for IriStr

impl<'_> PartialOrd<IriStr> for &'_ str

impl<'_> PartialOrd<str> for &'_ IriStr

impl<'_> PartialOrd<&'_ IriStr> for str

impl<'_> PartialOrd<Cow<'_, str>> for IriStr

impl<'_> PartialOrd<IriStr> for Cow<'_, str>

impl<'_, '_> PartialOrd<Cow<'_, str>> for &'_ IriStr

impl<'_, '_> PartialOrd<&'_ IriStr> for Cow<'_, str>

impl PartialOrd<IriStr> for IriString

impl PartialOrd<IriString> for IriStr

impl<'_> PartialOrd<&'_ IriStr> for IriString

impl<'_> PartialOrd<IriString> for &'_ IriStr

impl PartialOrd<IriReferenceStr> for IriStr[src]

impl PartialOrd<IriStr> for IriReferenceStr[src]

impl<'_> PartialOrd<&'_ IriReferenceStr> for IriStr[src]

impl<'_> PartialOrd<IriStr> for &'_ IriReferenceStr[src]

impl PartialOrd<IriReferenceString> for IriStr[src]

impl PartialOrd<IriStr> for IriReferenceString[src]

impl<'_> PartialOrd<Cow<'_, IriReferenceStr>> for IriStr[src]

impl<'_> PartialOrd<IriStr> for Cow<'_, IriReferenceStr>[src]

impl<'_> PartialOrd<IriReferenceStr> for &'_ IriStr[src]

impl<'_> PartialOrd<&'_ IriStr> for IriReferenceStr[src]

impl<'_> PartialOrd<IriReferenceString> for &'_ IriStr[src]

impl<'_> PartialOrd<&'_ IriStr> for IriReferenceString[src]

impl<'_, '_> PartialOrd<Cow<'_, IriReferenceStr>> for &'_ IriStr[src]

impl<'_, '_> PartialOrd<&'_ IriStr> for Cow<'_, IriReferenceStr>[src]

impl ToOwned for IriStr where
    String: From<&'a str>, 

type Owned = IriString

The resulting type after obtaining ownership.

impl Display for IriStr where
    str: Display

impl Debug for IriStr[src]

impl<'a> TryFrom<&'a IriStr> for &'a AbsoluteIriStr[src]

type Error = Error

The type returned in the event of a conversion error.

impl<'a> TryFrom<&'a str> for &'a IriStr

type Error = Error

The type returned in the event of a conversion error.

impl<'a> TryFrom<&'a IriReferenceStr> for &'a IriStr[src]

type Error = Error

The type returned in the event of a conversion error.

impl Deref for IriStr[src]

type Target = IriReferenceStr

The resulting type after dereferencing.

impl Hash for IriStr[src]

impl StructuralPartialEq for IriStr[src]

impl StructuralEq for IriStr[src]

impl Borrow<IriStr> for IriString

impl Serialize for IriStr[src]

impl<'de: 'a, 'a> Deserialize<'de> for &'a IriStr[src]

Auto Trait Implementations

impl Send for IriStr

impl Sync for IriStr

impl Unpin for IriStr

impl UnwindSafe for IriStr

impl RefUnwindSafe for IriStr

Blanket Implementations

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> ToString for T where
    T: Display + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]