Struct quick_xml::name::QName

source ·
pub struct QName<'a>(pub &'a [u8]);
Expand description

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

Tuple Fields§

§0: &'a [u8]

Implementations§

source§

impl<'a> QName<'a>

source

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

Converts this name to an internal slice representation.

source

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");
source

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()));
source

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.

source

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§

source§

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

source§

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

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

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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");
source§

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

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

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

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
source§

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

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

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

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl<'a> Serialize for QName<'a>

source§

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

Serialize this value into the given Serde serializer. Read more
source§

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

source§

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

source§

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

Auto Trait Implementations§

§

impl<'a> Freeze for QName<'a>

§

impl<'a> RefUnwindSafe for QName<'a>

§

impl<'a> Send for QName<'a>

§

impl<'a> Sync for QName<'a>

§

impl<'a> Unpin for QName<'a>

§

impl<'a> UnwindSafe for QName<'a>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,