Struct xml_dom::level2::ext::options::ProcessingOptions

pub struct ProcessingOptions(_);

This type encapsulates a set of options that a client can set that affect the processing of nodes as they are added/removed from the DOM. The default for ProcessingOptions is that none of the options are set, if the usual DOMImplementation::create_document method turns on any settings these are not set by default by create_document_with_options.

This type has a set of methods that turn on options, i.e. set_assume_ids, and retrieve the state of an option, i.e. has_assume_ids.

Example

The following will set an option to relax the rules on ID handling. By default the processor will treat all attributes with the prefix and local name xml:id or local name id and the namespace http://www.w3.org/XML/1998/namespace as IDs. With this option set all all attributes with the local name id regardless of prefix or namespace will be treated as an ID.

use xml_dom::level2::*;
use xml_dom::level2::convert::*;
use xml_dom::level2::ext::*;
use xml_dom::level2::ext::dom_impl::get_implementation_ext;

let mut options = ProcessingOptions::new();
options.set_assume_ids();

let implementation = get_implementation_ext();
let mut document_node = implementation
    .create_document_with_options(
        Some("http://www.w3.org/1999/xhtml"),
        Some("html"),
        None,
        options)
    .unwrap();

Implementations

impl ProcessingOptions

pub fn new() -> Self

Construct a new ProcessingOptions instance with all options off.

pub fn has_none(&self) -> bool

Returns true if all options are false.

pub fn has_assume_ids(&self) -> bool

Returns true if the document will automatically assume certain attributes will be treated as XML id values, else false.

pub fn has_parse_entities(&self) -> bool

Returns true if the document will parse entities inside text nodes and create EntityReference nodes, else false.

pub fn has_add_namespaces(&self) -> bool

Returns true if the document will automatically add namespace attributes to elements if qualified names are added that do not have current mappings., else false.

pub fn set_assume_ids(&mut self)

TBD.

Note: if an attribute with the qualified name xml:id, and the namespace is set to the XML namespace http://www.w3.org/XML/1998/namespace then the value is known to be an ID.

See xml:id Version 1.0, §4 Processing xml:id Attributes for more details.

pub fn set_parse_entities(&mut self)

TBD

pub fn set_add_namespaces(&mut self)

TBD

Trait Implementations

impl Binary for ProcessingOptions

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

Formats the value using the given formatter.

impl BitAnd<ProcessingOptions> for ProcessingOptions

type Output = ProcessingOptions

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitOr<ProcessingOptions> for ProcessingOptions

type Output = ProcessingOptions

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl Clone for ProcessingOptions

fn clone(&self) -> ProcessingOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProcessingOptions

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

Formats the value using the given formatter.

impl Default for ProcessingOptions

fn default() -> Self

Returns the “default value” for a type.

impl Display for ProcessingOptions

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

Formats the value using the given formatter.

impl PartialEq<ProcessingOptions> for ProcessingOptions

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

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

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

This method tests for !=.

impl Eq for ProcessingOptions

impl StructuralEq for ProcessingOptions

impl StructuralPartialEq for ProcessingOptions