You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Trac3r-rust/doc/xml/reader/enum.XmlEvent.html

130 lines
42 KiB

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!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="API documentation for the Rust `XmlEvent` enum in crate `xml`."><meta name="keywords" content="rust, rustlang, rust-lang, XmlEvent"><title>xml::reader::XmlEvent - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc enum"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../xml/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Enum XmlEvent</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.StartDocument">StartDocument</a><a href="#variant.EndDocument">EndDocument</a><a href="#variant.ProcessingInstruction">ProcessingInstruction</a><a href="#variant.StartElement">StartElement</a><a href="#variant.EndElement">EndElement</a><a href="#variant.CData">CData</a><a href="#variant.Comment">Comment</a><a href="#variant.Characters">Characters</a><a href="#variant.Whitespace">Whitespace</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.as_writer_event">as_writer_event</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-PartialEq%3CXmlEvent%3E">PartialEq&lt;XmlEvent&gt;</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow&lt;T&gt;</a><a href="#impl-BorrowMut%3CT%3E">BorrowMut&lt;T&gt;</a><a href="#impl-From%3CT%3E">From&lt;T&gt;</a><a href="#impl-Into%3CU%3E">Into&lt;U&gt;</a><a href="#impl-ToOwned">ToOwned</a><a href="#impl-TryFrom%3CU%3E">TryFrom&lt;U&gt;</a><a href="#impl-TryInto%3CU%3E">TryInto&lt;U&gt;</a></div></div><p class='location'><a href='../index.html'>xml</a>::<wbr><a href='index.html'>reader</a></p><script>window.sidebarCurrent = {name: 'XmlEvent', ty: 'enum', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/xml/reader/events.rs.html#16-115' title='goto source code'>[src]</a></span><span class='in-band'>Enum <a href='../index.html'>xml</a>::<wbr><a href='index.html'>reader</a>::<wbr><a class="enum" href=''>XmlEvent</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust enum'>pub enum XmlEvent {
StartDocument {
version: <a class="enum" href="../../xml/common/enum.XmlVersion.html" title="enum xml::common::XmlVersion">XmlVersion</a>,
encoding: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
standalone: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>&gt;,
},
EndDocument,
ProcessingInstruction {
name: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
data: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;,
},
StartElement {
name: <a class="struct" href="../../xml/name/struct.OwnedName.html" title="struct xml::name::OwnedName">OwnedName</a>,
attributes: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../../xml/attribute/struct.OwnedAttribute.html" title="struct xml::attribute::OwnedAttribute">OwnedAttribute</a>&gt;,
namespace: <a class="struct" href="../../xml/namespace/struct.Namespace.html" title="struct xml::namespace::Namespace">Namespace</a>,
},
EndElement {
name: <a class="struct" href="../../xml/name/struct.OwnedName.html" title="struct xml::name::OwnedName">OwnedName</a>,
},
CData(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>),
Comment(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>),
Characters(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>),
Whitespace(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>),
}</pre></div><div class='docblock'><p>An element of an XML input stream.</p>
<p>Items of this enum are emitted by <code>reader::EventReader</code>. They correspond to different
elements of an XML document.</p>
</div><h2 id='variants' class='variants small-section-header'>
Variants<a href='#variants' class='anchor'></a></h2>
<div id="variant.StartDocument" class="variant small-section-header"><a href="#variant.StartDocument" class="anchor field"></a><code id='StartDocument.v'>StartDocument</code></div><div class='docblock'><p>Corresponds to XML document declaration.</p>
<p>This event is always emitted before any other event. It is emitted
even if the actual declaration is not present in the document.</p>
</div><div class='autohide sub-variant' id='variant.StartDocument.fields'><h3>Fields of <b>StartDocument</b></h3><div><span id="variant.StartDocument.field.version" class="variant small-section-header"><a href="#variant.StartDocument.field.version" class="anchor field"></a><code id='StartDocument.v.version.v'>version:&nbsp;<a class="enum" href="../../xml/common/enum.XmlVersion.html" title="enum xml::common::XmlVersion">XmlVersion</a></code></span><div class='docblock'><p>XML version.</p>
<p>If XML declaration is not present, defaults to <code>Version10</code>.</p>
</div><span id="variant.StartDocument.field.encoding" class="variant small-section-header"><a href="#variant.StartDocument.field.encoding" class="anchor field"></a><code id='StartDocument.v.encoding.v'>encoding:&nbsp;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><div class='docblock'><p>XML document encoding.</p>
<p>If XML declaration is not present or does not contain <code>encoding</code> attribute,
defaults to <code>&quot;UTF-8&quot;</code>. This field is currently used for no other purpose than
informational.</p>
</div><span id="variant.StartDocument.field.standalone" class="variant small-section-header"><a href="#variant.StartDocument.field.standalone" class="anchor field"></a><code id='StartDocument.v.standalone.v'>standalone:&nbsp;<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>&gt;</code></span><div class='docblock'><p>XML standalone declaration.</p>
<p>If XML document is not present or does not contain <code>standalone</code> attribute,
defaults to <code>None</code>. This field is currently used for no other purpose than
informational.</p>
</div></div></div><div id="variant.EndDocument" class="variant small-section-header"><a href="#variant.EndDocument" class="anchor field"></a><code id='EndDocument.v'>EndDocument</code></div><div class='docblock'><p>Denotes to the end of the document stream.</p>
<p>This event is always emitted after any other event (except <code>Error</code>). After it
is emitted for the first time, it will always be emitted on next event pull attempts.</p>
</div><div id="variant.ProcessingInstruction" class="variant small-section-header"><a href="#variant.ProcessingInstruction" class="anchor field"></a><code id='ProcessingInstruction.v'>ProcessingInstruction</code></div><div class='docblock'><p>Denotes an XML processing instruction.</p>
<p>This event contains a processing instruction target (<code>name</code>) and opaque <code>data</code>. It
is up to the application to process them.</p>
</div><div class='autohide sub-variant' id='variant.ProcessingInstruction.fields'><h3>Fields of <b>ProcessingInstruction</b></h3><div><span id="variant.ProcessingInstruction.field.name" class="variant small-section-header"><a href="#variant.ProcessingInstruction.field.name" class="anchor field"></a><code id='ProcessingInstruction.v.name.v'>name:&nbsp;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><div class='docblock'><p>Processing instruction target.</p>
</div><span id="variant.ProcessingInstruction.field.data" class="variant small-section-header"><a href="#variant.ProcessingInstruction.field.data" class="anchor field"></a><code id='ProcessingInstruction.v.data.v'>data:&nbsp;<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;</code></span><div class='docblock'><p>Processing instruction content.</p>
</div></div></div><div id="variant.StartElement" class="variant small-section-header"><a href="#variant.StartElement" class="anchor field"></a><code id='StartElement.v'>StartElement</code></div><div class='docblock'><p>Denotes a beginning of an XML element.</p>
<p>This event is emitted after parsing opening tags or after parsing bodiless tags. In the
latter case <code>EndElement</code> event immediately follows.</p>
</div><div class='autohide sub-variant' id='variant.StartElement.fields'><h3>Fields of <b>StartElement</b></h3><div><span id="variant.StartElement.field.name" class="variant small-section-header"><a href="#variant.StartElement.field.name" class="anchor field"></a><code id='StartElement.v.name.v'>name:&nbsp;<a class="struct" href="../../xml/name/struct.OwnedName.html" title="struct xml::name::OwnedName">OwnedName</a></code></span><div class='docblock'><p>Qualified name of the element.</p>
</div><span id="variant.StartElement.field.attributes" class="variant small-section-header"><a href="#variant.StartElement.field.attributes" class="anchor field"></a><code id='StartElement.v.attributes.v'>attributes:&nbsp;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../../xml/attribute/struct.OwnedAttribute.html" title="struct xml::attribute::OwnedAttribute">OwnedAttribute</a>&gt;</code></span><div class='docblock'><p>A list of attributes associated with the element.</p>
<p>Currently attributes are not checked for duplicates (TODO)</p>
</div><span id="variant.StartElement.field.namespace" class="variant small-section-header"><a href="#variant.StartElement.field.namespace" class="anchor field"></a><code id='StartElement.v.namespace.v'>namespace:&nbsp;<a class="struct" href="../../xml/namespace/struct.Namespace.html" title="struct xml::namespace::Namespace">Namespace</a></code></span><div class='docblock'><p>Contents of the namespace mapping at this point of the document.</p>
</div></div></div><div id="variant.EndElement" class="variant small-section-header"><a href="#variant.EndElement" class="anchor field"></a><code id='EndElement.v'>EndElement</code></div><div class='docblock'><p>Denotes an end of an XML element.</p>
<p>This event is emitted after parsing closing tags or after parsing bodiless tags. In the
latter case it is emitted immediately after corresponding <code>StartElement</code> event.</p>
</div><div class='autohide sub-variant' id='variant.EndElement.fields'><h3>Fields of <b>EndElement</b></h3><div><span id="variant.EndElement.field.name" class="variant small-section-header"><a href="#variant.EndElement.field.name" class="anchor field"></a><code id='EndElement.v.name.v'>name:&nbsp;<a class="struct" href="../../xml/name/struct.OwnedName.html" title="struct xml::name::OwnedName">OwnedName</a></code></span><div class='docblock'><p>Qualified name of the element.</p>
</div></div></div><div id="variant.CData" class="variant small-section-header"><a href="#variant.CData" class="anchor field"></a><code id='CData.v'>CData(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></div><div class='docblock'><p>Denotes CDATA content.</p>
<p>This event contains unparsed data. No unescaping will be performed.</p>
<p>It is possible to configure a parser to emit <code>Characters</code> event instead of <code>CData</code>. See
<code>pull::ParserConfiguration</code> structure for more information.</p>
</div><div id="variant.Comment" class="variant small-section-header"><a href="#variant.Comment" class="anchor field"></a><code id='Comment.v'>Comment(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></div><div class='docblock'><p>Denotes a comment.</p>
<p>It is possible to configure a parser to ignore comments, so this event will never be emitted.
See <code>pull::ParserConfiguration</code> structure for more information.</p>
</div><div id="variant.Characters" class="variant small-section-header"><a href="#variant.Characters" class="anchor field"></a><code id='Characters.v'>Characters(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></div><div class='docblock'><p>Denotes character data outside of tags.</p>
<p>Contents of this event will always be unescaped, so no entities like <code>&amp;lt;</code> or <code>&amp;amp;</code> or <code>&amp;#123;</code>
will appear in it.</p>
<p>It is possible to configure a parser to trim leading and trailing whitespace for this event.
See <code>pull::ParserConfiguration</code> structure for more information.</p>
</div><div id="variant.Whitespace" class="variant small-section-header"><a href="#variant.Whitespace" class="anchor field"></a><code id='Whitespace.v'>Whitespace(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></div><div class='docblock'><p>Denotes a chunk of whitespace outside of tags.</p>
<p>It is possible to configure a parser to emit <code>Characters</code> event instead of <code>Whitespace</code>.
See <code>pull::ParserConfiguration</code> structure for more information. When combined with whitespace
trimming, it will eliminate standalone whitespace from the event stream completely.</p>
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><code class='in-band'>impl <a class="enum" href="../../xml/reader/enum.XmlEvent.html" title="enum xml::reader::XmlEvent">XmlEvent</a></code><a href='#impl' class='anchor'></a><a class='srclink' href='../../src/xml/reader/events.rs.html#152-219' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.as_writer_event' class="method"><code id='as_writer_event.v'>pub fn <a href='#method.as_writer_event' class='fnname'>as_writer_event</a>&lt;'a&gt;(&amp;'a self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="../../xml/writer/events/enum.XmlEvent.html" title="enum xml::writer::events::XmlEvent">XmlEvent</a>&lt;'a&gt;&gt;</code><a class='srclink' href='../../src/xml/reader/events.rs.html#191-218' title='goto source code'>[src]</a></h4><div class='docblock'><p>Obtains a writer event from this reader event.</p>
<p>This method is useful for streaming processing of XML documents where the output
is also an XML document. With this method it is possible to process some events
while passing other events through to the writer unchanged:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">str</span>;
<span class="kw">use</span> <span class="ident">xml</span>::{<span class="ident">EventReader</span>, <span class="ident">EventWriter</span>};
<span class="kw">use</span> <span class="ident">xml</span>::<span class="ident">reader</span>::<span class="ident">XmlEvent</span> <span class="kw">as</span> <span class="ident">ReaderEvent</span>;
<span class="kw">use</span> <span class="ident">xml</span>::<span class="ident">writer</span>::<span class="ident">XmlEvent</span> <span class="kw">as</span> <span class="ident">WriterEvent</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">input</span>: <span class="kw-2">&amp;</span>[<span class="ident">u8</span>] <span class="op">=</span> <span class="string">b&quot;&lt;hello&gt;world&lt;/hello&gt;&quot;</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">output</span>: <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">u8</span><span class="op">&gt;</span> <span class="op">=</span> <span class="ident">Vec</span>::<span class="ident">new</span>();
{
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">reader</span> <span class="op">=</span> <span class="ident">EventReader</span>::<span class="ident">new</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">input</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">writer</span> <span class="op">=</span> <span class="ident">EventWriter</span>::<span class="ident">new</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">output</span>);
<span class="kw">for</span> <span class="ident">e</span> <span class="kw">in</span> <span class="ident">reader</span> {
<span class="kw">match</span> <span class="ident">e</span>.<span class="ident">unwrap</span>() {
<span class="ident">ReaderEvent</span>::<span class="ident">Characters</span>(<span class="ident">s</span>) <span class="op">=</span><span class="op">&gt;</span>
<span class="ident">writer</span>.<span class="ident">write</span>(<span class="ident">WriterEvent</span>::<span class="ident">characters</span>(<span class="kw-2">&amp;</span><span class="ident">s</span>.<span class="ident">to_uppercase</span>())).<span class="ident">unwrap</span>(),
<span class="ident">e</span> <span class="op">=</span><span class="op">&gt;</span> <span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">e</span>) <span class="op">=</span> <span class="ident">e</span>.<span class="ident">as_writer_event</span>() {
<span class="ident">writer</span>.<span class="ident">write</span>(<span class="ident">e</span>).<span class="ident">unwrap</span>()
}
}
}
}
<span class="macro">assert_eq</span><span class="macro">!</span>(
<span class="ident">str</span>::<span class="ident">from_utf8</span>(<span class="kw-2">&amp;</span><span class="ident">output</span>).<span class="ident">unwrap</span>(),
<span class="string">r#&quot;&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;&lt;hello&gt;WORLD&lt;/hello&gt;&quot;#</span>
);</pre></div>
<p>Note that this API may change or get additions in future to improve its ergonomics.</p>
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Clone' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="../../xml/reader/enum.XmlEvent.html" title="enum xml::reader::XmlEvent">XmlEvent</a></code><a href='#impl-Clone' class='anchor'></a><a class='srclink' href='../../src/xml/reader/events.rs.html#15' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.clone' class="method hidden"><code id='clone.v'>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="enum" href="../../xml/reader/enum.XmlEvent.html" title="enum xml::reader::XmlEvent">XmlEvent</a></code><a class='srclink' href='../../src/xml/reader/events.rs.html#15' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method hidden"><code id='clone_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#131-133' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 id='impl-PartialEq%3CXmlEvent%3E' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>&lt;<a class="enum" href="../../xml/reader/enum.XmlEvent.html" title="enum xml::reader::XmlEvent">XmlEvent</a>&gt; for <a class="enum" href="../../xml/reader/enum.XmlEvent.html" title="enum xml::reader::XmlEvent">XmlEvent</a></code><a href='#impl-PartialEq%3CXmlEvent%3E' class='anchor'></a><a class='srclink' href='../../src/xml/reader/events.rs.html#15' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.eq' class="method hidden"><code id='eq.v'>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&amp;self, other: &amp;<a class="enum" href="../../xml/reader/enum.XmlEvent.html" title="enum xml::reader::XmlEvent">XmlEvent</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/xml/reader/events.rs.html#15' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
</div><h4 id='method.ne' class="method hidden"><code id='ne.v'>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&amp;self, other: &amp;<a class="enum" href="../../xml/reader/enum.XmlEvent.html" title="enum xml::reader::XmlEvent">XmlEvent</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/xml/reader/events.rs.html#15' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>!=</code>.</p>
</div></div><h3 id='impl-Debug' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="../../xml/reader/enum.XmlEvent.html" title="enum xml::reader::XmlEvent">XmlEvent</a></code><a href='#impl-Debug' class='anchor'></a><a class='srclink' href='../../src/xml/reader/events.rs.html#117-150' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.fmt' class="method hidden"><code id='fmt.v'>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class='srclink' href='../../src/xml/reader/events.rs.html#118-149' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Send' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="../../xml/reader/enum.XmlEvent.html" title="enum xml::reader::XmlEvent">XmlEvent</a></code><a href='#impl-Send' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Unpin' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="enum" href="../../xml/reader/enum.XmlEvent.html" title="enum xml::reader::XmlEvent">XmlEvent</a></code><a href='#impl-Unpin' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="../../xml/reader/enum.XmlEvent.html" title="enum xml::reader::XmlEvent">XmlEvent</a></code><a href='#impl-Sync' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-UnwindSafe' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="enum" href="../../xml/reader/enum.XmlEvent.html" title="enum xml::reader::XmlEvent">XmlEvent</a></code><a href='#impl-UnwindSafe' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-RefUnwindSafe' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="enum" href="../../xml/reader/enum.XmlEvent.html" title="enum xml::reader::XmlEvent">XmlEvent</a></code><a href='#impl-RefUnwindSafe' class='anchor'></a></h3><div class='impl-items'></div></div><h2 id='blanket-implementations' class='small-section-header'>Blanket Implementations<a href='#blanket-implementations' class='anchor'></a></h2><div id='blanket-implementations-list'><h3 id='impl-ToOwned' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,&nbsp;</span></code><a href='#impl-ToOwned' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#81-92' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Owned' class="type"><code id='Owned.t'>type <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned' class="type">Owned</a> = T</code></h4><div class='docblock'><p>The resulting type after obtaining ownership.</p>
</div><h4 id='method.to_owned' class="method hidden"><code id='to_owned.v'>fn <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned' class='fnname'>to_owned</a>(&amp;self) -&gt; T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#85-87' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
</div><h4 id='method.clone_into' class="method hidden"><code id='clone_into.v'>fn <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into' class='fnname'>clone_into</a>(&amp;self, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>T)</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#89-91' title='goto source code'>[src]</a></h4><div class='stability hidden'><div class='stab unstable'><details><summary><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</summary><p>recently added</p>
</details></div></div><div class='docblock hidden'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
</div></div><h3 id='impl-Into%3CU%3E' class='impl'><code class='in-band'>impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,&nbsp;</span></code><a href='#impl-Into%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#544-549' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -&gt; U</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#546-548' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-From%3CT%3E' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for T</code><a href='#impl-From%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#553-555' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method hidden"><code id='from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -&gt; T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#554' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-TryFrom%3CU%3E' class='impl'><code class='in-band'>impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,&nbsp;</span></code><a href='#impl-TryFrom%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#572-578' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4 id='method.try_from' class="method hidden"><code id='try_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#575-577' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-TryInto%3CU%3E' class='impl'><code class='in-band'>impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,&nbsp;</span></code><a href='#impl-TryInto%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#560-567' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4 id='method.try_into' class="method hidden"><code id='try_into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#564-566' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-BorrowMut%3CT%3E' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code><a href='#impl-BorrowMut%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code id='borrow_mut.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
</div></div><h3 id='impl-Borrow%3CT%3E' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code><a href='#impl-Borrow%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-215' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code id='borrow.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
</div></div><h3 id='impl-Any' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code><a href='#impl-Any' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id' class='fnname'>type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd></kbd></dt><dd>Move up in search results</dd><dt><kbd></kbd></dt><dd>Move down in search results</dd><dt><kbd></kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "xml";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>