Struct rxml::writer::SimpleNamespaces

pub struct SimpleNamespaces { /* private fields */ }

Simple namespace tracker.

 This is the default namespace tracker used by Encoder::new. At the cost of increased output size, it reduces memory footprint by only tracking unprefixed namespaces. Prefixed namespaces may be declared, but are forgotten about once the element start is over.

Effectively, when used with an Encoder, this means that prefixed namespaces will only ever be used for attributes, and may be re-declared a lot.

 One exception is that prefixed namespaces declared on the root element will actually be made available on all child elements.

Implementations

impl SimpleNamespaces

pub fn new() -> Self

pub fn lookup_prefix(
    &self,
    prefix: Option<&NcNameStr>
) -> Result<NamespaceName, PrefixError>

Look up the namespace URI for a given prefix

 Note: This function is implemented as O(n) function because it should rarely, if ever, be necessary to use. Speeding up runtime of this function would increase memory cost at neglegible gain.

The namespace URIs for the xml and xmlns prefixes are always returned, even if not explicitly declared.

Trait Implementations

impl Debug for SimpleNamespaces

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

Formats the value using the given formatter.

impl TrackNamespace for SimpleNamespaces

fn declare_fixed(
    &mut self,
    prefix: Option<&NcNameStr>,
    name: Option<NamespaceName>
) -> bool

Declare a namespace URI with a defined prefix.

fn declare_auto(
    &mut self,
    name: Option<NamespaceName>
) -> (bool, Option<&NcNameStr>)

Declare a namespace URI with an auto-generated prefix or by using the default namespace.

fn declare_with_auto_prefix(
    &mut self,
    name: Option<NamespaceName>
) -> (bool, &NcNameStr)

Declare a namespace URI with an auto-generated prefix.

fn get_prefix_or_default(
    &self,
    name: Option<NamespaceName>
) -> Result<Option<&NcNameStr>, PrefixError>

Get the prefix for a given URI, which may be empty if the namespace with that URI is defined as the default namespace.

fn get_prefix(
    &self,
    name: Option<NamespaceName>
) -> Result<&NcNameStr, PrefixError>

Get the prefix for a given URI.

fn push(&mut self)

Complete an element declaration.

fn pop(&mut self)

Signal end of element to undeclare nested namespace declarations.

fn new_default_declaration(&self) -> Option<Option<&NamespaceName>>

Return the newly declared default namespace, if any.

fn new_prefix_declarations<'x>(
    &'x self
) -> Box<dyn Iterator<Item = (&Option<NamespaceName>, &NcNameStr)> + 'x>

Return an iterator over the the newly declared prefixes.