Struct Eqname

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

String slice for EQName.

EQName is union of QName and URIQualifiedName. See the documentation for Qname type and UriQualifiedName type.

Implementations

impl Eqname

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

Creates a new &UriQualifiedName.

Failures

Fails if the given string is not a valid EQName.

Examples

let prefixed_q = Eqname::from_str("foo:bar")?;
assert_eq!(prefixed_q, "foo:bar");

let nc = Eqname::from_str("ncname")?;
assert_eq!(nc, "ncname");

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

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

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

Creates a new &Eqname without validation.

Safety

The given string should be a valid EQName.

Examples

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

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

pub fn as_str(&self) -> &str

Returns the string as &str.

Examples

let q = Eqname::from_str("foo:bar")?;
assert_eq!(q, "foo:bar");
assert_eq!(q.as_str(), "foo:bar");

let uri_qualified = Eqname::from_str("Q{foo}bar")?;
assert_eq!(uri_qualified, "Q{foo}bar");
assert_eq!(uri_qualified.as_str(), "Q{foo}bar");

pub fn len(&self) -> usize

Returns the length of the string in bytes.

Examples

let q = Eqname::from_str("foo:bar")?;
assert_eq!(q.len(), "foo:bar".len());

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

pub fn to_variant(&self) -> EqnameVariantData<&Qname, &UriQualifiedName>

Returns the name in the type specific to the variant (i.e. Qname or UriQualifiedName).

pub fn as_qname(&self) -> Option<&Qname>

Returns the string as QName, if valid.

pub fn as_uri_qualified_name(&self) -> Option<&UriQualifiedName>

Returns the string as URIQualifiedName, if valid.

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

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

Exmaples

let input = "foo:bar:012";
let expected = Eqname::from_str("foo:bar")
    .expect("valid QName");
assert_eq!(
    Eqname::parse_next(input),
    Ok((expected, ":012"))
);

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

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

pub fn namespace(&self) -> EqnameNamespace<'_>

Returns the namespace part if available: prefix for Qname, URI for UriQualifiedName.

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

Examples

use xml_string::names::{EqnameNamespace, Ncname, Qname};

let nc = Eqname::from_str("local")?;
assert_eq!(nc.namespace(), EqnameNamespace::None);

let q = Eqname::from_str("foo:bar")?;
let q_prefix = Ncname::from_str("foo")
    .expect("Should never fail: Valid NCName");
assert_eq!(q.namespace(), EqnameNamespace::Prefix(q_prefix));

let uri_qualified = Eqname::from_str("Q{foo}bar")?;
assert_eq!(uri_qualified.namespace(), EqnameNamespace::Uri("foo"));

let uri_qualified_empty = Eqname::from_str("Q{}bar")?;
assert_eq!(uri_qualified_empty.namespace(), EqnameNamespace::Uri(""));

pub fn local_name(&self) -> &Ncname

Returns the local name.

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

Examples

let q = Eqname::from_str("foo:bar")?;
assert_eq!(q.local_name(), "bar");

let nc = Eqname::from_str("bar")?;
assert_eq!(nc.local_name(), "bar");

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

pub fn namespace_and_local(&self) -> (EqnameNamespace<'_>, &Ncname)

Returns a pair of the namespace and the local name.

This returns the same result as (self.namespace(), self.local_name()), but more efficiently than calling Eqname::namespace and Eqname::local_name individually.

Examples

use xml_string::names::{EqnameNamespace, Ncname};

let ncname_bar = Ncname::from_str("bar")
    .expect("Should never fail: Valid NCName");

let nc = Eqname::from_str("bar")?;
assert_eq!(nc.namespace_and_local(), (EqnameNamespace::None, ncname_bar));

let q = Eqname::from_str("foo:bar")?;
let expected_prefix = Ncname::from_str("foo")
    .expect("Should never fail: Valid NCName");
assert_eq!(
    q.namespace_and_local(),
    (EqnameNamespace::Prefix(expected_prefix), ncname_bar)
);

let uri_qualified = Eqname::from_str("Q{foo}bar")?;
assert_eq!(uri_qualified.namespace_and_local(), (EqnameNamespace::Uri("foo"), ncname_bar));

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

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

Examples

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

fn as_ref(&self) -> &Eqname

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

impl AsRef<Eqname> for Ncname

fn as_ref(&self) -> &Eqname

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

impl AsRef<Eqname> for ParsedEqname<'_>

fn as_ref(&self) -> &Eqname

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

impl AsRef<Eqname> for ParsedQname<'_>

fn as_ref(&self) -> &Eqname

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

impl AsRef<Eqname> for ParsedUriQualifiedName<'_>

fn as_ref(&self) -> &Eqname

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

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<Eqname> for UriQualifiedName

fn as_ref(&self) -> &Eqname

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

impl AsRef<str> for Box<Eqname>

fn as_ref(&self) -> &str

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

impl AsRef<str> for Eqname

fn as_ref(&self) -> &str

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

impl Debug for &Eqname

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

Formats the value using the given formatter.

impl Display for &Eqname

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

Formats the value using the given formatter.

impl From<&Eqname> for Arc<Eqname>

fn from(s: &Eqname) -> Self

Converts to this type from the input type.

impl From<&Eqname> for Box<Eqname>

fn from(s: &Eqname) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<&Eqname> for Rc<Eqname>

fn from(s: &Eqname) -> Self

Converts to this type from the input type.

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

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 UriQualifiedName> for &'a Eqname

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl Hash for Eqname

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

Feeds this value into the given Hasher.

impl Ord for Eqname

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

This method returns an Ordering between self and other.

impl PartialEq<&Eqname> for str

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

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 Eqname

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 Eqname

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 Eqname

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

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

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

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

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

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

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

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 &Eqname

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

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 Eqname

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 Eqname

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

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

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 Eqname

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 Eqname

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 Eqname

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

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

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

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

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

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

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

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 &Eqname

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

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 Eqname

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 Eqname

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

type Owned = Box<Eqname>

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

type Error = NameError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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 Eqname

impl StructuralPartialEq for Eqname