Struct ruma::html::QualName

pub struct QualName {
    pub prefix: Option<Atom<PrefixStaticSet>>,
    pub ns: Atom<NamespaceStaticSet>,
    pub local: Atom<LocalNameStaticSet>,
}

A fully qualified name (with a namespace), used to depict names of tags and attributes.

Namespaces can be used to differentiate between similar XML fragments. For example:

// HTML
<table>
  <tr>
    <td>Apples</td>
    <td>Bananas</td>
  </tr>
</table>

// Furniture XML
<table>
  <name>African Coffee Table</name>
  <width>80</width>
  <length>120</length>
</table>

Without XML namespaces, we can’t use those two fragments in the same document at the same time. However if we declare a namespace we could instead say:

// Furniture XML
<furn:table xmlns:furn="https://furniture.rs">
  <furn:name>African Coffee Table</furn:name>
  <furn:width>80</furn:width>
  <furn:length>120</furn:length>
</furn:table>

and bind the prefix furn to a different namespace.

For this reason we parse names that contain a colon in the following way:

<furn:table>
   |    |
   |    +- local name
   |
 prefix (when resolved gives namespace_url `https://furniture.rs`)

NOTE: Prefix, LocalName and Prefix are all derivative of string_cache::atom::Atom and Atom implements Deref<str>.

Fields

prefix: Option<Atom<PrefixStaticSet>>

The prefix of qualified (e.g. furn in <furn:table> above). Optional (since some namespaces can be empty or inferred), and only useful for namespace resolution (since different prefix can still resolve to same namespace)

use markup5ever::{QualName, Namespace, LocalName, Prefix};

let qual = QualName::new(
    Some(Prefix::from("furn")),
    Namespace::from("https://furniture.rs"),
    LocalName::from("table"),
);

assert_eq!("furn", &qual.prefix.unwrap());

ns: Atom<NamespaceStaticSet>

The namespace after resolution (e.g. https://furniture.rs in example above).

assert_eq!("https://furniture.rs", &qual.ns);

When matching namespaces used by HTML we can use ns! macro. Although keep in mind that ns! macro only works with namespaces that are present in HTML spec (like html, xmlns, svg, etc.).

#[macro_use] extern crate markup5ever;


let html_table = QualName::new(
   None,
   ns!(html),
   LocalName::from("table"),
);

assert!(
  match html_table.ns {
    ns!(html) => true,
    _ => false,
  }
);

local: Atom<LocalNameStaticSet>

The local name (e.g. table in <furn:table> above).

assert_eq!("table", &qual.local);

When matching local name we can also use the local_name! macro:

#[macro_use] extern crate markup5ever;



// Initialize qual to furniture example

assert!(
  match qual.local {
    local_name!("table") => true,
    _ => false,
  }
);

Implementations

impl QualName

pub fn new( prefix: Option<Atom<PrefixStaticSet>>, ns: Atom<NamespaceStaticSet>, local: Atom<LocalNameStaticSet>, ) -> QualName

Basic constructor function.

First let’s try it for the following example where QualName is defined as:

<furn:table> <!-- namespace url is https://furniture.rs -->

Given this definition, we can define QualName using strings.

use markup5ever::{QualName, Namespace, LocalName, Prefix};

let qual_name = QualName::new(
    Some(Prefix::from("furn")),
    Namespace::from("https://furniture.rs"),
    LocalName::from("table"),
);

If we were instead to construct this element instead:

<table>
 ^^^^^---- no prefix and thus default html namespace

Or could define it using macros, like so:

#[macro_use] extern crate markup5ever;
use markup5ever::{QualName, Namespace, LocalName, Prefix};

let qual_name = QualName::new(
    None,
    ns!(html),
    local_name!("table")
);

Let’s analyse the above example. Since we have no prefix its value is None. Second we have html namespace. In html5ever html namespaces are supported out of the box, we can write ns!(html) instead of typing Namespace::from("http://www.w3.org/1999/xhtml"). Local name is also one of the HTML elements local names, so can use local_name!("table") macro.

pub fn expanded(&self) -> ExpandedName<'_>

Take a reference of self as an ExpandedName, dropping the unresolved prefix.

In XML and HTML prefixes are only used to extract the relevant namespace URI. Expanded name only contains resolved namespace and tag name, which are only relevant parts of an XML or HTML tag and attribute name respectively.

In lieu of our XML Namespace example

<furn:table> <!-- namespace url is https://furniture.rs -->

For it the expanded name would become roughly equivalent to:

ExpandedName {
   ns: "https://furniture.rs",
   local: "table",
}

Trait Implementations

impl Clone for QualName

fn clone(&self) -> QualName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QualName

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

Formats the value using the given formatter.

impl<'a> ElemName for &'a QualName

fn ns(&self) -> &Atom<NamespaceStaticSet>

fn local_name(&self) -> &Atom<LocalNameStaticSet>

fn expanded(&self) -> ExpandedName<'_>

impl Hash for QualName

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

where __H: Hasher,

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 Ord for QualName

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for QualName

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

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

impl StructuralPartialEq for QualName