Struct xml_string::names::ParsedQname

pub struct ParsedQname<'a> { /* fields omitted */ }

Parsed QName reference.

Implementations

impl<'a> ParsedQname<'a>

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

Creates a new ParsedQname<'_> from the given string slice.

Failures

Fails if the given string is not a valid QName.

Examples

let noprefix = ParsedQname::from_str("hello")?;
assert_eq!(noprefix, "hello");

let prefixed = ParsedQname::from_str("foo:bar")?;
assert_eq!(prefixed, "foo:bar");

assert!(ParsedQname::from_str("").is_err(), "Empty string is not a QName");
assert!(ParsedQname::from_str("foo bar").is_err(), "Whitespace is not allowed");
assert!(ParsedQname::from_str("foo:bar:baz").is_err(), "Two or more colons are not allowed");
assert!(ParsedQname::from_str("0foo").is_err(), "ASCII digit at the beginning is not allowed");

#[must_use]pub fn as_qname(&self) -> &'a Qname

Returns the string as &Qname.

Exmaples

use xml_string::names::Qname;

let name = ParsedQname::from_str("hello")?;
assert_eq!(name, "hello");

let s: &Qname = name.as_qname();
assert_eq!(s, "hello");

#[must_use]pub fn as_str(&self) -> &'a str

Returns the string as &str.

Exmaples

let name = ParsedQname::from_str("hello")?;
assert_eq!(name, "hello");

let s: &str = name.as_str();
assert_eq!(s, "hello");

#[must_use]pub fn has_prefix(&self) -> bool

Returns whether the QName has a prefix.

Examples

let local_only = ParsedQname::from_str("hello")?;
assert!(!local_only.has_prefix());

let prefixed = ParsedQname::from_str("foo:bar")?;
assert!(prefixed.has_prefix());

#[must_use]pub fn prefix(&self) -> Option<&'a Ncname>

Returns the prefix, if available.

Examples

let prefixed = ParsedQname::from_str("foo:bar")?;
assert_eq!(prefixed.prefix().map(|s| s.as_str()), Some("foo"));

let noprefix = ParsedQname::from_str("foo")?;
assert_eq!(noprefix.prefix().map(|s| s.as_str()), None);

#[must_use]pub fn local_part(&self) -> &'a Ncname

Returns the local part.

Examples

let prefixed = ParsedQname::from_str("foo:bar")?;
assert_eq!(prefixed.local_part(), "bar");

let noprefix = ParsedQname::from_str("foo")?;
assert_eq!(noprefix.local_part(), "foo");

#[must_use]pub fn prefix_and_local(&self) -> (Option<&'a Ncname>, &'a Ncname)

Returns a pair of the prefix (if available) and the local part.

This is efficient version of (self.prefix(), self.local_part()).

Examples

use std::convert::TryFrom;

let noprefix = ParsedQname::from_str("hello")?;
assert_eq!(noprefix.prefix_and_local(), (noprefix.prefix(), noprefix.local_part()));

let prefixed = ParsedQname::from_str("foo:bar")?;
assert_eq!(prefixed.prefix_and_local(), (prefixed.prefix(), prefixed.local_part()));

Trait Implementations

impl<'_> AsRef<Qname> for ParsedQname<'_>

pub fn as_ref(&self) -> &Qname

Performs the conversion.

impl<'_> AsRef<str> for ParsedQname<'_>

pub fn as_ref(&self) -> &str

Performs the conversion.

impl<'a> Clone for ParsedQname<'a>

pub fn clone(&self) -> ParsedQname<'a>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Copy for ParsedQname<'a>

impl<'_> Debug for ParsedQname<'_>

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

Formats the value using the given formatter.

impl<'_> Display for ParsedQname<'_>

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

Formats the value using the given formatter.

impl<'a> Eq for ParsedQname<'a>

impl<'a> From<&'a Qname> for ParsedQname<'a>

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

Performs the conversion.

impl<'a> From<ParsedQname<'a>> for &'a Qname

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

Performs the conversion.

impl<'a> Hash for ParsedQname<'a>

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

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for ParsedQname<'a>

pub fn cmp(&self, other: &ParsedQname<'a>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<'_, '_> PartialEq<&'_ ParsedQname<'_>> for str

pub fn eq(&self, o: &&ParsedQname<'_>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_, '_> PartialEq<&'_ String> for ParsedQname<'_>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_, '_> PartialEq<&'_ str> for ParsedQname<'_>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<Box<str, Global>> for ParsedQname<'_>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<ParsedQname<'_>> for str

pub fn eq(&self, o: &ParsedQname<'_>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_, '_> PartialEq<ParsedQname<'_>> for &'_ str

pub fn eq(&self, o: &ParsedQname<'_>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<ParsedQname<'_>> for String

pub fn eq(&self, o: &ParsedQname<'_>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_, '_> PartialEq<ParsedQname<'_>> for &'_ String

pub fn eq(&self, o: &ParsedQname<'_>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<ParsedQname<'_>> for Box<str>

pub fn eq(&self, o: &ParsedQname<'_>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

pub fn eq(&self, o: &ParsedQname<'_>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<ParsedQname<'a>> for ParsedQname<'a>

pub fn eq(&self, other: &ParsedQname<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &ParsedQname<'a>) -> bool

This method tests for !=.

impl<'_> PartialEq<String> for ParsedQname<'_>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<str> for ParsedQname<'_>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_, '_> PartialEq<str> for &'_ ParsedQname<'_>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_, '_> PartialOrd<&'_ ParsedQname<'_>> for str

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl<'_> PartialOrd<ParsedQname<'_>> for str

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl<'_, '_> PartialOrd<ParsedQname<'_>> for &'_ str

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl<'_> PartialOrd<ParsedQname<'_>> for String

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl<'_, '_> PartialOrd<ParsedQname<'_>> for &'_ String

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl<'_> PartialOrd<ParsedQname<'_>> for Box<str>

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

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

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl<'a> PartialOrd<ParsedQname<'a>> for ParsedQname<'a>

pub fn partial_cmp(&self, other: &ParsedQname<'a>) -> Option<Ordering>

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

pub fn lt(&self, other: &ParsedQname<'a>) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &ParsedQname<'a>) -> bool

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

pub fn gt(&self, other: &ParsedQname<'a>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &ParsedQname<'a>) -> bool

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

impl<'a> StructuralEq for ParsedQname<'a>

impl<'a> StructuralPartialEq for ParsedQname<'a>

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

type Error = NameError

The type returned in the event of a conversion error.

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

Performs the conversion.