Struct Qname

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

String slice for QName.

Implementations

impl Qname

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

Creates a new &Qname.

Failures

Fails if the given string is not a valid QName.

Examples

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

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

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

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

Creates a new &Qname without validation.

Safety

The given string should be a valid QName.

Examples

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

pub fn as_str(&self) -> &str

Returns the string as &str.

Examples

let name = Qname::from_str("foo:bar")?;
assert_eq!(name, "foo:bar");

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

pub fn len(&self) -> usize

Returns the length of the string in bytes.

Examples

let name = Qname::from_str("foo:bar")?;
assert_eq!(name.len(), 7);

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

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

Exmaples

let input = "hello:012";
let expected = Qname::from_str("hello").expect("valid Qname");
assert_eq!(
    Qname::parse_next(input),
    Ok((expected, ":012"))
);

let input = "hello:world:foo";
let expected = Qname::from_str("hello:world").expect("valid Qname");
assert_eq!(
    Qname::parse_next(input),
    Ok((expected, ":foo"))
);

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

pub fn has_prefix(&self) -> bool

Returns whether the QName has a prefix.

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

Examples

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

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

pub fn prefix(&self) -> Option<&Ncname>

Returns the prefix if available.

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

Examples

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

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

pub fn local_part(&self) -> &Ncname

Returns the local part.

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

Examples

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

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

pub fn prefix_and_local(&self) -> (Option<&Ncname>, &Ncname)

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

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

Examples

use std::convert::TryFrom;

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

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

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

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

Examples

let name = Qname::from_str("q:name")?;
let boxed_name: Box<Qname> = 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 Qname

fn as_ref(&self) -> &Eqname

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

impl AsRef<Name> for Qname

fn as_ref(&self) -> &Name

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

impl AsRef<Nmtoken> for Qname

fn as_ref(&self) -> &Nmtoken

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

impl AsRef<Qname> for Ncname

fn as_ref(&self) -> &Qname

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

impl AsRef<Qname> for ParsedQname<'_>

fn as_ref(&self) -> &Qname

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

impl AsRef<Qname> for Qname

fn as_ref(&self) -> &Qname

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

impl AsRef<str> for Box<Qname>

fn as_ref(&self) -> &str

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

impl AsRef<str> for Qname

fn as_ref(&self) -> &str

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

impl Debug for &Qname

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

Formats the value using the given formatter.

impl Display for &Qname

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<&Qname> for Arc<Qname>

fn from(s: &Qname) -> Self

Converts to this type from the input type.

impl From<&Qname> for Box<Qname>

fn from(s: &Qname) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<&Qname> for Rc<Qname>

fn from(s: &Qname) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl Hash for Qname

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

Feeds this value into the given Hasher.

impl Ord for Qname

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

This method returns an Ordering between self and other.

impl PartialEq<&Qname> for str

fn eq(&self, o: &&Qname) -> 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 Qname

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<&str> for Qname

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 Qname

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 Qname

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<Qname> for &String

fn eq(&self, o: &Qname) -> 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<Qname> for &str

fn eq(&self, o: &Qname) -> 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<Qname> for Box<str>

fn eq(&self, o: &Qname) -> 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<Qname> for Cow<'_, str>

fn eq(&self, o: &Qname) -> 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<Qname> for String

fn eq(&self, o: &Qname) -> 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<Qname> for str

fn eq(&self, o: &Qname) -> 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 Qname

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<str> for &Qname

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<Qname>

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 Qname

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 Qname

fn eq(&self, other: &Qname) -> 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<&Qname> for str

fn partial_cmp(&self, o: &&Qname) -> 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 Qname

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<&str> for Qname

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 Qname

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 Qname

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<Qname> for &String

fn partial_cmp(&self, o: &Qname) -> 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<Qname> for &str

fn partial_cmp(&self, o: &Qname) -> 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<Qname> for Box<str>

fn partial_cmp(&self, o: &Qname) -> 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<Qname> for Cow<'_, str>

fn partial_cmp(&self, o: &Qname) -> 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<Qname> for String

fn partial_cmp(&self, o: &Qname) -> 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<Qname> for str

fn partial_cmp(&self, o: &Qname) -> 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 Qname

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<str> for &Qname

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<Qname>

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 Qname

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 Qname

fn partial_cmp(&self, other: &Qname) -> 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 Qname

type Owned = Box<Qname>

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 Qname> for &'a Ncname

type Error = NameError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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 Qname

impl StructuralPartialEq for Qname