Struct xml::namespace::NamespaceStack

pub struct NamespaceStack(pub Vec<Namespace>);

Namespace stack is a sequence of namespaces.

Namespace stack is used to represent cumulative namespace consisting of combined namespaces from nested elements.

Methods

impl NamespaceStack

pub fn empty() -> NamespaceStack

Returns an empty namespace stack.

pub fn default() -> NamespaceStack

Returns a namespace stack with default items in it.

Default items are the following:

• xml → http://www.w3.org/XML/1998/namespace;
• xmlns → http://www.w3.org/2000/xmlns/.

pub fn push_empty(&mut self) -> &mut NamespaceStack

Adds an empty namespace to the top of this stack.

pub fn pop(&mut self) -> Namespace

Removes the topmost namespace in this stack.

Panics if the stack is empty.

pub fn try_pop(&mut self) -> Option<Namespace>

Removes the topmost namespace in this stack.

Returns Some(namespace) if this stack is not empty and None otherwise.

pub fn peek_mut(&mut self) -> &mut Namespace

Borrows the topmost namespace mutably, leaving the stack intact.

Panics if the stack is empty.

pub fn peek(&self) -> &Namespace

Borrows the topmost namespace immutably, leaving the stack intact.

Panics if the stack is empty.

pub fn put_checked<P, U>(&mut self, prefix: P, uri: U) -> bool where
    P: Into<String> + AsRef<str>,
    U: Into<String> + AsRef<str>, 

Puts a mapping into the topmost namespace if this stack does not already contain one.

Returns a boolean flag indicating whether the insertion has completed successfully. Note that both key and value are matched and the mapping is inserted if either namespace prefix is not already mapped, or if it is mapped, but to a different URI.

Parameters

• prefix --- namespace prefix;
• uri --- namespace URI.

Return value

true if prefix has been inserted successfully; false if the prefix was already present in the namespace stack.

pub fn put<P, U>(&mut self, prefix: P, uri: U) -> bool where
    P: Into<String>,
    U: Into<String>, 

Puts a mapping into the topmost namespace in this stack.

This method does not override a mapping in the topmost namespace if it is already present, however, it does not depend on other namespaces in the stack, so it is possible to put a mapping which is present in lower namespaces.

Returns a boolean flag indicating whether the insertion has completed successfully.

Parameters

• prefix --- namespace prefix;
• uri --- namespace URI.

Return value

true if prefix has been inserted successfully; false if the prefix was already present in the namespace.

pub fn get<'a, P: ?Sized + AsRef<str>>(&'a self, prefix: &P) -> Option<&'a str>

Performs a search for the given prefix in the whole stack.

This method walks the stack from top to bottom, querying each namespace in order for the given prefix. If none of the namespaces contains the prefix, None is returned.

Parameters

• prefix --- namespace prefix.

pub fn squash(&self) -> Namespace

Combines this stack of namespaces into a single namespace.

Namespaces are combined in left-to-right order, that is, rightmost namespace elements take priority over leftmost ones.

pub fn checked_target(&mut self) -> CheckedTarget

Returns an object which implements Extend using put_checked() instead of put().

See CheckedTarget for more information.

Important traits for NamespaceStackMappings<'a>

impl<'a> Iterator for NamespaceStackMappings<'a> type Item = UriMapping<'a>;

pub fn iter(&self) -> NamespaceStackMappings

Returns an iterator over all mappings in this namespace stack.

Trait Implementations

impl Eq for NamespaceStack

impl Clone for NamespaceStack

fn clone(&self) -> NamespaceStack

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Extend<(&'a str, &'a str)> for NamespaceStack

fn extend<T>(&mut self, iterable: T) where
    T: IntoIterator<Item = UriMapping<'a>>, 

Extends a collection with the contents of an iterator.

impl PartialEq<NamespaceStack> for NamespaceStack

fn eq(&self, other: &NamespaceStack) -> bool

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

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

This method tests for !=.

impl<'a> IntoIterator for &'a NamespaceStack

type Item = UriMapping<'a>

The type of the elements being iterated over.

type IntoIter = NamespaceStackMappings<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Debug for NamespaceStack

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

Formats the value using the given formatter.