Struct UriQualifiedName

pub struct UriQualifiedName(/* private fields */);

String slice for URIQualifiedName.

Implementations

impl UriQualifiedName

pub fn from_str(s: &str) -> Result<&Self, NameError>

Creates a new &UriQualifiedName.

URIQualifiedName has Q{uri}ncname format. UriQualifiedName type validates NCName part, but does not validate URI part.

In most contexts, processors are not required to raise errors if a URI is not lexically valid according to RFC3986 and RFC3987. See 2.4.5 URI Literals for details.

— XML Path Language (XPath) 3.1, 2 Basics

XPath 3.1 requires a statically known, valid URI in a BracedURILiteral. An implementation may raise a static error err:XQST0046 if the value of a Braced URI Literal is of nonzero length and is neither an absolute URI nor a relative URI.

— XML Path Language (XPath) 3.1, 2.4.5 URI Literals

It is user’s responsibility to validate URI part if necessary.

Failures

Fails if the given string is not a valid URIQualifiedName.

Examples

let name = UriQualifiedName::from_str("Q{http://example.com/}name")?;
assert_eq!(name, "Q{http://example.com/}name");

assert_eq!(
    UriQualifiedName::from_str("Q{}name")?,
    "Q{}name",
    "Empty URI is OK"
);
assert_eq!(
    UriQualifiedName::from_str("Q{foo}bar")?,
    "Q{foo}bar",
    "URI is not validated"
);

assert!(
    UriQualifiedName::from_str("foo").is_err(),
    "URIQualifiedName has `Q{{uri}}ncname` format"
);
assert!(
    UriQualifiedName::from_str("Q{http://example.com}foo:bar").is_err(),
    "Colon is not allowed"
);
assert!(
    UriQualifiedName::from_str("Q{foo{bar}qux").is_err(),
    "URI part cannot have `{{` and `}}`"
);

pub unsafe fn new_unchecked(s: &str) -> &Self

Creates a new &UriQualifiedName without validation.

Safety

The given string should be a valid URIQualifiedName.

Examples

let name = unsafe {
    UriQualifiedName::new_unchecked("Q{foo}bar")
};
assert_eq!(name, "Q{foo}bar");

pub fn as_str(&self) -> &str

Returns the string as &str.

Examples

let name = UriQualifiedName::from_str("Q{foo}bar")?;
assert_eq!(name, "Q{foo}bar");

let s: &str = name.as_str();
assert_eq!(s, "Q{foo}bar");

pub fn len(&self) -> usize

Returns the length of the string in bytes.

Examples

let name = UriQualifiedName::from_str("Q{foo}bar")?;
assert_eq!(name.len(), "Q{foo}bar".len());

pub fn parse_next(s: &str) -> Result<(&Self, &str), NameError>

Parses the leading UriQualifiedName and returns the value and the rest input.

Exmaples

let input = "Q{foo}bar:012";
let expected = UriQualifiedName::from_str("Q{foo}bar")
    .expect("valid UriQualifiedName");
assert_eq!(
    UriQualifiedName::parse_next(input),
    Ok((expected, ":012"))
);

let input = "012";
assert!(UriQualifiedName::parse_next(input).is_err());

pub fn uri(&self) -> &str

Returns the URI.

Note that this is O(length) operation. Consider using ParsedUriQualifiedName::uri method if possible.

Examples

let name = UriQualifiedName::from_str("Q{foo}bar")?;
assert_eq!(name.uri(), "foo");

let empty_uri = UriQualifiedName::from_str("Q{}foo")?;
assert_eq!(empty_uri.uri(), "");

pub fn local_name(&self) -> &Ncname

Returns the local name.

Note that this is O(length) operation. Consider using ParsedUriQualifiedName::local_name method if possible.

Examples

let name = UriQualifiedName::from_str("Q{foo}bar")?;
assert_eq!(name.local_name(), "bar");

pub fn uri_and_local(&self) -> (&str, &Ncname)

Returns a pair of the uri and the local name.

Note that this is O(length) operation. Consider using ParsedUriQualifiedName::uri_and_local method if possible.

Examples

use std::convert::TryFrom;

let name = UriQualifiedName::from_str("Q{foo}bar")?;
assert_eq!(name.uri_and_local(), (name.uri(), name.local_name()));

pub fn into_boxed_str(self: Box<Self>) -> Box<str>

Converts a Box<UriQualifiedName> into a Box<str> without copying or allocating.

Examples

let name = UriQualifiedName::from_str("Q{foo}bar")?;
let boxed_name: Box<UriQualifiedName> = name.into();
assert_eq!(&*boxed_name, name);
let boxed_str: Box<str> = boxed_name.into_boxed_str();
assert_eq!(&*boxed_str, name.as_str());

Trait Implementations

impl AsRef<Eqname> for UriQualifiedName

fn as_ref(&self) -> &Eqname

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<UriQualifiedName> for ParsedUriQualifiedName<'_>

fn as_ref(&self) -> &UriQualifiedName

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<UriQualifiedName> for UriQualifiedName

fn as_ref(&self) -> &UriQualifiedName

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for Box<UriQualifiedName>

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for UriQualifiedName

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for &UriQualifiedName

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for &UriQualifiedName

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> From<&'a UriQualifiedName> for &'a Eqname

fn from(s: &'a UriQualifiedName) -> Self

Converts to this type from the input type.

impl From<&UriQualifiedName> for Arc<UriQualifiedName>

fn from(s: &UriQualifiedName) -> Self

Converts to this type from the input type.

impl From<&UriQualifiedName> for Box<UriQualifiedName>

fn from(s: &UriQualifiedName) -> Self

Converts to this type from the input type.

impl<'a> From<&'a UriQualifiedName> for ParsedUriQualifiedName<'a>

fn from(s: &'a UriQualifiedName) -> Self

Converts to this type from the input type.

impl From<&UriQualifiedName> for Rc<UriQualifiedName>

fn from(s: &UriQualifiedName) -> Self

Converts to this type from the input type.

impl<'a> From<ParsedUriQualifiedName<'a>> for &'a UriQualifiedName

fn from(s: ParsedUriQualifiedName<'a>) -> Self

Converts to this type from the input type.

impl Hash for UriQualifiedName

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

impl Ord for UriQualifiedName

fn cmp(&self, other: &UriQualifiedName) -> Ordering

This method returns an Ordering between self and other.

impl PartialEq<&String> for UriQualifiedName

fn eq(&self, o: &&String) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<&UriQualifiedName> for str

fn eq(&self, o: &&UriQualifiedName) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<&str> for UriQualifiedName

fn eq(&self, o: &&str) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Box<str>> for UriQualifiedName

fn eq(&self, o: &Box<str>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

fn eq(&self, o: &Cow<'_, str>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<String> for UriQualifiedName

fn eq(&self, o: &String) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<UriQualifiedName> for &String

fn eq(&self, o: &UriQualifiedName) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<UriQualifiedName> for &str

fn eq(&self, o: &UriQualifiedName) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<UriQualifiedName> for Box<str>

fn eq(&self, o: &UriQualifiedName) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

fn eq(&self, o: &UriQualifiedName) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<UriQualifiedName> for String

fn eq(&self, o: &UriQualifiedName) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<UriQualifiedName> for str

fn eq(&self, o: &UriQualifiedName) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<str> for &UriQualifiedName

fn eq(&self, o: &str) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<str> for Box<UriQualifiedName>

fn eq(&self, o: &str) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<str> for UriQualifiedName

fn eq(&self, o: &str) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for UriQualifiedName

fn eq(&self, other: &UriQualifiedName) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<&String> for UriQualifiedName

fn partial_cmp(&self, o: &&String) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<&UriQualifiedName> for str

fn partial_cmp(&self, o: &&UriQualifiedName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<&str> for UriQualifiedName

fn partial_cmp(&self, o: &&str) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<Box<str>> for UriQualifiedName

fn partial_cmp(&self, o: &Box<str>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

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

fn partial_cmp(&self, o: &Cow<'_, str>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<String> for UriQualifiedName

fn partial_cmp(&self, o: &String) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<UriQualifiedName> for &String

fn partial_cmp(&self, o: &UriQualifiedName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<UriQualifiedName> for &str

fn partial_cmp(&self, o: &UriQualifiedName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<UriQualifiedName> for Box<str>

fn partial_cmp(&self, o: &UriQualifiedName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

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

fn partial_cmp(&self, o: &UriQualifiedName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<UriQualifiedName> for String

fn partial_cmp(&self, o: &UriQualifiedName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<UriQualifiedName> for str

fn partial_cmp(&self, o: &UriQualifiedName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<str> for &UriQualifiedName

fn partial_cmp(&self, o: &str) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<str> for Box<UriQualifiedName>

fn partial_cmp(&self, o: &str) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<str> for UriQualifiedName

fn partial_cmp(&self, o: &str) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd for UriQualifiedName

fn partial_cmp(&self, other: &UriQualifiedName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl ToOwned for UriQualifiedName

type Owned = Box<UriQualifiedName>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

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

type Error = NameError

The type returned in the event of a conversion error.

fn try_from(s: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for UriQualifiedName

impl StructuralPartialEq for UriQualifiedName