Struct elementtree::QName

pub struct QName<'a> { /* private fields */ }

A QName represents a qualified name.

A qualified name is a tag or attribute name that has a namespace and a local name. If the namespace is empty no namespace is assumed. It can be constructed from a qualified name string with the from method.

Notes on Memory Management

Qualified names that are user constructed for comparison purposes usually have a static lifetime because they are created from static strings. Creating qualified names from other strings might make memory management harder which is why share() exists which moves the QName internal strings to shared storage in which the lifetime changes to 'static.

Common usage examples:

let href = QName::from_name("href");
let a = QName::from("{http://www.w3.org/1999/xhtml}a");

Implementations

impl<'a> QName<'a>

pub fn from(s: &'a str) -> QName<'a>

Creates a qualified name from a given string.

Two formats are supported {namespace}tag or just tag.

let a = QName::from("{http://www.w3.org/1999/xhtml}a");

pub fn from_name(name: &'a str) -> QName<'a>

Creates a qualified name from a given string without namespace.

This is slightly faster than using from().

pub fn from_ns_name(ns: Option<&'a str>, name: &'a str) -> QName<'a>

Creates a qualified name from a namespace and name.

pub fn name(&self) -> &str

Returns the name portion of the qualified name. This is the local tag or attribute name.

pub fn ns(&self) -> Option<&str>

Returns the optional namespace of this element. This is the URL of the namespace and not the prefix. The information about the latter is not retained.

pub fn share(&self) -> QName<'static>

Creates a shared QName with static lifetime from an already existing QName. The internal strings are interned and might be shared with other instances.

Trait Implementations

impl<'a> AsQName<'a> for &'a QName<'a>

fn as_qname(&self) -> Cow<'a, QName<'a>>

Returns a Cow’ed QName from the given object.

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

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

Formats the value using the given formatter.

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, 

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) -> Self

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self where
    Self: 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> Eq for QName<'a>