Files
phy/roxmltree/index.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

6 lines
7.7 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Represent an XML document as a read-only tree."><title>roxmltree - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="roxmltree" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../roxmltree/index.html">roxmltree</a><span class="version">0.20.0</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#constants" title="Constants">Constants</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>roxmltree</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/roxmltree/lib.rs.html#1-1746">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Represent an <a href="https://www.w3.org/TR/xml/">XML</a> document as a read-only tree.</p>
<p>The root point of the documentations is <a href="struct.Document.html#method.parse"><code>Document::parse</code></a>.</p>
<p>You can find more details in the <a href="https://github.com/RazrFalcon/roxmltree/blob/master/README.md">README</a> and the <a href="https://github.com/RazrFalcon/roxmltree/blob/master/docs/parsing.md">parsing doc</a>.</p>
<p>The tree structure itself is a heavily modified <a href="https://github.com/causal-agent/ego-tree">https://github.com/causal-agent/ego-tree</a>
License: ISC.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Attribute.html" title="struct roxmltree::Attribute">Attribute</a></div><div class="desc docblock-short">An attribute.</div></li><li><div class="item-name"><a class="struct" href="struct.Attributes.html" title="struct roxmltree::Attributes">Attributes</a></div><div class="desc docblock-short">Iterator over a nodes attributes</div></li><li><div class="item-name"><a class="struct" href="struct.AxisIter.html" title="struct roxmltree::AxisIter">Axis<wbr>Iter</a></div><div class="desc docblock-short">Iterator over specified axis.</div></li><li><div class="item-name"><a class="struct" href="struct.Children.html" title="struct roxmltree::Children">Children</a></div><div class="desc docblock-short">Iterator over children.</div></li><li><div class="item-name"><a class="struct" href="struct.Descendants.html" title="struct roxmltree::Descendants">Descendants</a></div><div class="desc docblock-short">Iterator over a node and its descendants.</div></li><li><div class="item-name"><a class="struct" href="struct.Document.html" title="struct roxmltree::Document">Document</a></div><div class="desc docblock-short">An XML tree container.</div></li><li><div class="item-name"><a class="struct" href="struct.ExpandedName.html" title="struct roxmltree::ExpandedName">Expanded<wbr>Name</a></div><div class="desc docblock-short">An expanded name.</div></li><li><div class="item-name"><a class="struct" href="struct.Namespace.html" title="struct roxmltree::Namespace">Namespace</a></div><div class="desc docblock-short">A namespace.</div></li><li><div class="item-name"><a class="struct" href="struct.NamespaceIter.html" title="struct roxmltree::NamespaceIter">Namespace<wbr>Iter</a></div><div class="desc docblock-short">Iterator over the namespaces attached to a node.</div></li><li><div class="item-name"><a class="struct" href="struct.Node.html" title="struct roxmltree::Node">Node</a></div><div class="desc docblock-short">A node in a document.</div></li><li><div class="item-name"><a class="struct" href="struct.NodeId.html" title="struct roxmltree::NodeId">NodeId</a></div><div class="desc docblock-short">A node ID stored as <code>u32</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.PI.html" title="struct roxmltree::PI">PI</a></div><div class="desc docblock-short">A processing instruction.</div></li><li><div class="item-name"><a class="struct" href="struct.ParsingOptions.html" title="struct roxmltree::ParsingOptions">Parsing<wbr>Options</a></div><div class="desc docblock-short">Parsing options.</div></li><li><div class="item-name"><a class="struct" href="struct.TextPos.html" title="struct roxmltree::TextPos">TextPos</a></div><div class="desc docblock-short">Position in text.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.Error.html" title="enum roxmltree::Error">Error</a></div><div class="desc docblock-short">A list of all possible errors.</div></li><li><div class="item-name"><a class="enum" href="enum.NodeType.html" title="enum roxmltree::NodeType">Node<wbr>Type</a></div><div class="desc docblock-short">A list of supported node types.</div></li><li><div class="item-name"><a class="enum" href="enum.StringStorage.html" title="enum roxmltree::StringStorage">String<wbr>Storage</a></div><div class="desc docblock-short">A string storage.</div></li></ul><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.NS_XMLNS_URI.html" title="constant roxmltree::NS_XMLNS_URI">NS_<wbr>XMLNS_<wbr>URI</a></div><div class="desc docblock-short">The <a href="http://www.w3.org/2000/xmlns/">http://www.w3.org/2000/xmlns/</a> URI.</div></li><li><div class="item-name"><a class="constant" href="constant.NS_XML_URI.html" title="constant roxmltree::NS_XML_URI">NS_<wbr>XML_<wbr>URI</a></div><div class="desc docblock-short">The <a href="http://www.w3.org/XML/1998/namespace">http://www.w3.org/XML/1998/namespace</a> URI.</div></li></ul></section></div></main></body></html>