Struct quick_xml::name::QName

pub struct QName<'a>(pub &'a [u8]);

A qualified name of an element or an attribute, including an optional namespace prefix and a local name.

Tuple Fields

0: &'a [u8]

Implementations

impl<'a> QName<'a>

pub fn into_inner(self) -> &'a [u8]

Converts this name to an internal slice representation.

pub fn local_name(&self) -> LocalName<'a>

Returns local part of this qualified name.

All content up to and including the first : character is removed from the tag name.

Examples

let simple = QName(b"simple-name");
assert_eq!(simple.local_name().as_ref(), b"simple-name");

let qname = QName(b"namespace:simple-name");
assert_eq!(qname.local_name().as_ref(), b"simple-name");

pub fn prefix(&self) -> Option<Prefix<'a>>

Returns namespace part of this qualified name or None if namespace part is not defined (symbol ':' not found).

Examples

let simple = QName(b"simple-name");
assert_eq!(simple.prefix(), None);

let qname = QName(b"prefix:simple-name");
assert_eq!(qname.prefix().as_ref().map(|n| n.as_ref()), Some(b"prefix".as_ref()));

pub fn decompose(&self) -> (LocalName<'a>, Option<Prefix<'a>>)

The same as (qname.local_name(), qname.prefix()), but does only one lookup for a ':' symbol.

pub fn as_namespace_binding(&self) -> Option<PrefixDeclaration<'a>>

If that QName represents "xmlns" series of names, returns Some, otherwise None is returned.

Examples

let qname = QName(b"xmlns");
assert_eq!(qname.as_namespace_binding(), Some(PrefixDeclaration::Default));

let qname = QName(b"xmlns:prefix");
assert_eq!(qname.as_namespace_binding(), Some(PrefixDeclaration::Named(b"prefix")));

// Be aware that this method does not check the validity of the prefix - it can be empty!
let qname = QName(b"xmlns:");
assert_eq!(qname.as_namespace_binding(), Some(PrefixDeclaration::Named(b"")));

let qname = QName(b"other-name");
assert_eq!(qname.as_namespace_binding(), None);

// https://www.w3.org/TR/xml-names11/#xmlReserved
let qname = QName(b"xmlns-reserved-name");
assert_eq!(qname.as_namespace_binding(), None);

Trait Implementations

impl<'a> AsRef<[u8]> for QName<'a>

fn as_ref(&self) -> &[u8]

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

impl<'a> Clone for QName<'a>

fn clone(&self) -> QName<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for QName<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for QName<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<QName<'a>> for LocalName<'a>

fn from(name: QName<'a>) -> Self

Creates LocalName from a QName

Examples

let local: LocalName = QName(b"unprefixed").into();
assert_eq!(local.as_ref(), b"unprefixed");

let local: LocalName = QName(b"some:prefix").into();
assert_eq!(local.as_ref(), b"prefix");

impl<'a> Hash for QName<'a>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for QName<'a>

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<'a> PartialEq<QName<'a>> for QName<'a>

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

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

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

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

impl<'a> PartialOrd<QName<'a>> for QName<'a>

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

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

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

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

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

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

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

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

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> Serialize for QName<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Copy for QName<'a>

impl<'a> Eq for QName<'a>

impl<'a> StructuralEq for QName<'a>

impl<'a> StructuralPartialEq for QName<'a>