Struct xml::namespace::Namespace

pub struct Namespace(pub BTreeMap<String, String>);

Namespace is a map from prefixes to namespace URIs.

No prefix (i.e. default namespace) is designated by NS_NO_PREFIX constant.

Methods

impl Namespace

pub fn empty() -> Namespace

Returns an empty namespace.

pub fn is_empty(&self) -> bool

Checks whether this namespace is empty.

pub fn is_essentially_empty(&self) -> bool

Checks whether this namespace is essentially empty, that is, it does not contain anything but default mappings.

pub fn contains<P: ?Sized + AsRef<str>>(&self, prefix: &P) -> bool

Checks whether this namespace mapping contains the given prefix.

Parameters

• prefix --- namespace prefix.

Return value

true if this namespace contains the given prefix, false otherwise.

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

Puts a mapping into this namespace.

This method does not override any already existing mappings.

Returns a boolean flag indicating whether the map already contained the given prefix.

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 force_put<P, U>(&mut self, prefix: P, uri: U) -> Option<String> where
    P: Into<String>,
    U: Into<String>, 

Puts a mapping into this namespace forcefully.

This method, unlike put(), does replace an already existing mapping.

Returns previous URI which was assigned to the given prefix, if it is present.

Parameters

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

Return value

Some(uri) with uri being a previous URI assigned to the prefix, or None if such prefix was not present in the namespace before.

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

Queries the namespace for the given prefix.

Parameters

• prefix --- namespace prefix.

Return value

Namespace URI corresponding to the given prefix, if it is present.

Trait Implementations

impl Eq for Namespace

impl Clone for Namespace

fn clone(&self) -> Namespace

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 Namespace

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

Extends a collection with the contents of an iterator.

impl PartialEq<Namespace> for Namespace

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

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

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

This method tests for !=.

impl<'a> IntoIterator for &'a Namespace

type Item = UriMapping<'a>

The type of the elements being iterated over.

type IntoIter = NamespaceMappings<'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 Namespace

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

Formats the value using the given formatter.