summaryrefslogtreecommitdiffstats
path: root/target/doc/mailparse/struct.MailHeader.html
diff options
context:
space:
mode:
Diffstat (limited to 'target/doc/mailparse/struct.MailHeader.html')
-rw-r--r--target/doc/mailparse/struct.MailHeader.html62
1 files changed, 42 insertions, 20 deletions
diff --git a/target/doc/mailparse/struct.MailHeader.html b/target/doc/mailparse/struct.MailHeader.html
index 0b9c995..9073746 100644
--- a/target/doc/mailparse/struct.MailHeader.html
+++ b/target/doc/mailparse/struct.MailHeader.html
@@ -10,8 +10,11 @@
<title>mailparse::MailHeader - Rust</title>
<link rel="stylesheet" type="text/css" href="../normalize.css">
- <link rel="stylesheet" type="text/css" href="../rustdoc.css">
- <link rel="stylesheet" type="text/css" href="../main.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="../main.css" id="themeStyle">
+ <script src="../storage.js"></script>
@@ -28,10 +31,18 @@
<nav class="sidebar">
+ <div class="sidebar-menu">&#9776;</div>
- <p class='location'>Struct MailHeader</p><div class="block items"><ul><li><a href="#methods">Methods</a></li><li><a href="#implementations">Trait Implementations</a></li></ul></div><p class='location'><a href='index.html'>mailparse</a></p><script>window.sidebarCurrent = {name: 'MailHeader', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
+ <p class='location'>Struct MailHeader</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.get_key">get_key</a><a href="#method.get_value">get_value</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a></div></div><p class='location'><a href='index.html'>mailparse</a></p><script>window.sidebarCurrent = {name: 'MailHeader', ty: 'struct', 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">
@@ -48,31 +59,38 @@
<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/mailparse/lib.rs.html#93-96' title='goto source code'>[src]</a></span></h1>
+ </span><a class='srclink' href='../src/mailparse/lib.rs.html#92-95' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct MailHeader&lt;'a&gt; { /* fields omitted */ }</pre><div class='docblock'><p>A struct that represents a single header in the message.
It holds slices into the raw byte array passed to parse_mail, and so the
lifetime of this struct must be contained within the lifetime of the raw
input. There are additional accessor functions on this struct to extract
the data as Rust strings.</p>
-</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl&lt;'a&gt; <a class="struct" href="../mailparse/struct.MailHeader.html" title="struct mailparse::MailHeader">MailHeader</a>&lt;'a&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mailparse/lib.rs.html#148-268' title='goto source code'>[src]</a></span></h3>
-<div class='impl-items'><h4 id='method.get_key' class="method"><span id='get_key.v' class='invisible'><code>fn <a href='#method.get_key' class='fnname'>get_key</a>(&amp;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;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="enum" href="../mailparse/enum.MailParseError.html" title="enum mailparse::MailParseError">MailParseError</a>&gt;</code></span></h4>
+</div>
+ <h2 id='methods' class='small-section-header'>
+ Methods<a href='#methods' class='anchor'></a>
+ </h2>
+ <h3 id='impl' class='impl'><span class='in-band'><code>impl&lt;'a&gt; <a class="struct" href="../mailparse/struct.MailHeader.html" title="struct mailparse::MailHeader">MailHeader</a>&lt;'a&gt;</code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mailparse/lib.rs.html#147-267' title='goto source code'>[src]</a></span></h3>
+<div class='impl-items'><h4 id='method.get_key' class="method"><span id='get_key.v' class='invisible'><code>pub fn <a href='#method.get_key' class='fnname'>get_key</a>(&amp;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;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="enum" href="../mailparse/enum.MailParseError.html" title="enum mailparse::MailParseError">MailParseError</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mailparse/lib.rs.html#149-157' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Get the name of the header. Note that header names are case-insensitive.</p>
-</div><h4 id='method.get_value' class="method"><span id='get_value.v' class='invisible'><code>fn <a href='#method.get_value' class='fnname'>get_value</a>(&amp;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;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="enum" href="../mailparse/enum.MailParseError.html" title="enum mailparse::MailParseError">MailParseError</a>&gt;</code></span></h4>
+</div><h4 id='method.get_value' class="method"><span id='get_value.v' class='invisible'><code>pub fn <a href='#method.get_value' class='fnname'>get_value</a>(&amp;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;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="enum" href="../mailparse/enum.MailParseError.html" title="enum mailparse::MailParseError">MailParseError</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mailparse/lib.rs.html#205-266' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Get the value of the header. Any sequences of newlines characters followed
by whitespace are collapsed into a single space. In effect, header values
wrapped across multiple lines are compacted back into one line, while
discarding the extra whitespace required by the MIME format. Additionally,
any quoted-printable words in the value are decoded.</p>
-
-<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
+<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<pre class="rust rust-example-rendered">
-<span class="kw">use</span> <span class="ident">mailparse</span>::<span class="ident">parse_header</span>;
+ <span class="kw">use</span> <span class="ident">mailparse</span>::<span class="ident">parse_header</span>;
<span class="kw">let</span> (<span class="ident">parsed</span>, _) <span class="op">=</span> <span class="ident">parse_header</span>(<span class="string">b&quot;Subject: =?iso-8859-1?Q?=A1Hola,_se=F1or!?=&quot;</span>).<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">parsed</span>.<span class="ident">get_key</span>().<span class="ident">unwrap</span>(), <span class="string">&quot;Subject&quot;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">parsed</span>.<span class="ident">get_value</span>().<span class="ident">unwrap</span>(), <span class="string">&quot;\u{a1}Hola, se\u{f1}or!&quot;</span>);</pre>
-</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl&lt;'a&gt; <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="struct" href="../mailparse/struct.MailHeader.html" title="struct mailparse::MailHeader">MailHeader</a>&lt;'a&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mailparse/lib.rs.html#92' title='goto source code'>[src]</a></span></h3>
-<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &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></span></h4>
-<div class='docblock'><p>Formats the value using the given formatter.</p>
+</div></div>
+ <h2 id='implementations' class='small-section-header'>
+ Trait Implementations<a href='#implementations' class='anchor'></a>
+ </h2>
+ <h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl&lt;'a&gt; <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="struct" href="../mailparse/struct.MailHeader.html" title="struct mailparse::MailHeader">MailHeader</a>&lt;'a&gt;</code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mailparse/lib.rs.html#91' title='goto source code'>[src]</a></span></h3>
+<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mailparse/lib.rs.html#91' title='goto source code'>[src]</a></span></h4>
+<div class='docblock'><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></section>
<section id='search' class="content hidden"></section>
@@ -86,18 +104,22 @@ any quoted-printable words in the value are decoded.</p>
<h2>Keyboard Shortcuts</h2>
<dl>
- <dt>?</dt>
+ <dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
- <dt>S</dt>
+ <dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
- <dt>&larrb;</dt>
+ <dt><kbd>↑</kbd></dt>
<dd>Move up in search results</dd>
- <dt>&rarrb;</dt>
+ <dt><kbd>↓</kbd></dt>
<dd>Move down in search results</dd>
- <dt>&#9166;</dt>
+ <dt><kbd>↹</kbd></dt>
+ <dd>Switch tab</dd>
+ <dt><kbd>&#9166;</kbd></dt>
<dd>Go to active search result</dd>
- <dt>+</dt>
- <dd>Collapse/expand all sections</dd>
+ <dt><kbd>+</kbd></dt>
+ <dd>Expand all sections</dd>
+ <dt><kbd>-</kbd></dt>
+ <dd>Collapse all sections</dd>
</dl>
</div>