summaryrefslogtreecommitdiffstats
path: root/target/doc/mailparse/struct.MailHeader.html
diff options
context:
space:
mode:
authorKartikaya Gupta <kats@seldon.staktrace.com>2016-12-26 09:14:43 -0500
committerKartikaya Gupta <kats@seldon.staktrace.com>2016-12-26 09:14:43 -0500
commit42a5e14da5fdff58f9b668f7fc6fd6fd1b39f770 (patch)
tree3bad45f0b4d1672d84943b174136eee129b9598a /target/doc/mailparse/struct.MailHeader.html
parentfb43433e34bb42575e21bc913c51dc4060a009ee (diff)
Update documentation
Diffstat (limited to 'target/doc/mailparse/struct.MailHeader.html')
-rw-r--r--target/doc/mailparse/struct.MailHeader.html21
1 files changed, 12 insertions, 9 deletions
diff --git a/target/doc/mailparse/struct.MailHeader.html b/target/doc/mailparse/struct.MailHeader.html
index a6c44c7..948dac6 100644
--- a/target/doc/mailparse/struct.MailHeader.html
+++ b/target/doc/mailparse/struct.MailHeader.html
@@ -47,17 +47,16 @@
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
- </span><a id='src-126' class='srclink' href='../src/mailparse/src/lib.rs.html#92-95' title='goto source code'>[src]</a></span></h1>
-<pre class='rust struct'>pub struct MailHeader&lt;'a&gt; {
- // some fields omitted
-}</pre><div class='docblock'><p>A struct that represents a single header in the message.
+ </span><a id='src-118' class='srclink' href='../src/mailparse/src/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'><code>impl&lt;'a&gt; <a class='struct' href='../mailparse/struct.MailHeader.html' title='mailparse::MailHeader'>MailHeader</a>&lt;'a&gt;</code></h3><div class='impl-items'><h4 id='method.get_key' class='method'><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='core::result::Result'>Result</a>&lt;<a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>, <a class='enum' href='../mailparse/enum.MailParseError.html' title='mailparse::MailParseError'>MailParseError</a>&gt;</code></h4>
+</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='mailparse::MailHeader'>MailHeader</a>&lt;'a&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a id='src-152' class='srclink' href='../src/mailparse/src/lib.rs.html#147-257' 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='core::result::Result'>Result</a>&lt;<a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>,&nbsp;<a class='enum' href='../mailparse/enum.MailParseError.html' title='mailparse::MailParseError'>MailParseError</a>&gt;</code></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'><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='core::result::Result'>Result</a>&lt;<a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>, <a class='enum' href='../mailparse/enum.MailParseError.html' title='mailparse::MailParseError'>MailParseError</a>&gt;</code></h4>
+</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='core::result::Result'>Result</a>&lt;<a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>,&nbsp;<a class='enum' href='../mailparse/enum.MailParseError.html' title='mailparse::MailParseError'>MailParseError</a>&gt;</code></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
@@ -69,9 +68,11 @@ any quoted-printable words in the value are decoded.</p>
<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 id='derived_implementations'>Derived Implementations </h3><h3 class='impl'><code>impl&lt;'a&gt; <a class='trait' href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html' title='core::fmt::Debug'>Debug</a> for <a class='struct' href='../mailparse/struct.MailHeader.html' title='mailparse::MailHeader'>MailHeader</a>&lt;'a&gt;</code></h3><div class='impl-items'><h4 id='method.fmt' class='method'><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='core::fmt::Formatter'>Formatter</a>) -&gt; <a class='type' href='https://doc.rust-lang.org/nightly/core/fmt/type.Result.html' title='core::fmt::Result'>Result</a></code></h4>
-</div></section>
+ <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>);<a class='test-arrow' target='_blank' href=''>Run</a></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='core::fmt::Debug'>Debug</a> for <a class='struct' href='../mailparse/struct.MailHeader.html' title='mailparse::MailHeader'>MailHeader</a>&lt;'a&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a id='src-122' class='srclink' href='../src/mailparse/src/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='core::fmt::Formatter'>Formatter</a>) -&gt; <a class='type' href='https://doc.rust-lang.org/nightly/core/fmt/type.Result.html' title='core::fmt::Result'>Result</a></code></span></h4>
+<div class='docblock'><p>Formats the value using the given formatter.</p>
+</div></div></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
@@ -94,6 +95,8 @@ any quoted-printable words in the value are decoded.</p>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
+ <dt>+</dt>
+ <dd>Collapse/expand all sections</dd>
</dl>
</div>