diff options
Diffstat (limited to 'target/doc/mailparse/trait.MailHeaderMap.html')
| -rw-r--r-- | target/doc/mailparse/trait.MailHeaderMap.html | 65 |
1 files changed, 44 insertions, 21 deletions
diff --git a/target/doc/mailparse/trait.MailHeaderMap.html b/target/doc/mailparse/trait.MailHeaderMap.html index 333e8bc..ed479b1 100644 --- a/target/doc/mailparse/trait.MailHeaderMap.html +++ b/target/doc/mailparse/trait.MailHeaderMap.html @@ -10,8 +10,11 @@ <title>mailparse::MailHeaderMap - 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">☰</div> - <p class='location'>Trait MailHeaderMap</p><div class="block items"><ul><li><a href="#required-methods">Required Methods</a></li><li><a href="#implementors">Implementors</a></li></ul></div><p class='location'><a href='index.html'>mailparse</a></p><script>window.sidebarCurrent = {name: 'MailHeaderMap', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script> + <p class='location'>Trait MailHeaderMap</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.get_first_value">get_first_value</a><a href="#tymethod.get_all_values">get_all_values</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-MailHeaderMap">Vec<MailHeader<'a>></a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>mailparse</a></p><script>window.sidebarCurrent = {name: 'MailHeaderMap', ty: 'trait', 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,7 +59,7 @@ <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs"> [<span class='inner'>−</span>] </a> - </span><a class='srclink' href='../src/mailparse/lib.rs.html#383-417' title='goto source code'>[src]</a></span></h1> + </span><a class='srclink' href='../src/mailparse/lib.rs.html#382-416' title='goto source code'>[src]</a></span></h1> <pre class='rust trait'>pub trait MailHeaderMap { fn <a href='#tymethod.get_first_value' class='fnname'>get_first_value</a>(<br> &self, <br> key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<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>>; <div class='item-spacer'></div> fn <a href='#tymethod.get_all_values' class='fnname'>get_all_values</a>(&self, key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<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>>; @@ -56,15 +67,16 @@ function. It provides a map-like interface to look up header values by their name.</p> </div> - <h2 id='required-methods'>Required Methods</h2> + <h2 id='required-methods' class='small-section-header'> + Required Methods<a href='#required-methods' class='anchor'></a> + </h2> <div class='methods'> <h3 id='tymethod.get_first_value' class='method'><span id='get_first_value.v' class='invisible'><code>fn <a href='#tymethod.get_first_value' class='fnname'>get_first_value</a>(&self, key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<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>></code></span></h3><div class='docblock'><p>Look through the list of headers and return the value of the first one that matches the provided key. It returns Ok(None) if the no matching header was found. Header names are matched case-insensitively.</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_mail</span>, <span class="ident">MailHeaderMap</span>}; + <span class="kw">use</span> <span class="ident">mailparse</span>::{<span class="ident">parse_mail</span>, <span class="ident">MailHeaderMap</span>}; <span class="kw">let</span> <span class="ident">headers</span> <span class="op">=</span> <span class="ident">parse_mail</span>(<span class="macro">concat</span><span class="macro">!</span>( <span class="string">"Subject: Test\n"</span>, <span class="string">"\n"</span>, @@ -76,10 +88,9 @@ matching the provided key. Returns an empty vector if no matching headers were found. The order of the returned values is the same as the order of the matching headers in the message. Header names are matched case-insensitively.</p> - -<h1 id='examples-1' class='section-header'><a href='#examples-1'>Examples</a></h1> +<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1> <pre class="rust rust-example-rendered"> -<span class="kw">use</span> <span class="ident">mailparse</span>::{<span class="ident">parse_mail</span>, <span class="ident">MailHeaderMap</span>}; + <span class="kw">use</span> <span class="ident">mailparse</span>::{<span class="ident">parse_mail</span>, <span class="ident">MailHeaderMap</span>}; <span class="kw">let</span> <span class="ident">headers</span> <span class="op">=</span> <span class="ident">parse_mail</span>(<span class="macro">concat</span><span class="macro">!</span>( <span class="string">"Key: Value1\n"</span>, <span class="string">"Key: Value2"</span>).<span class="ident">as_bytes</span>()) @@ -87,10 +98,18 @@ case-insensitively.</p> <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">headers</span>.<span class="ident">get_all_values</span>(<span class="string">"Key"</span>).<span class="ident">unwrap</span>(), <span class="macro">vec</span><span class="macro">!</span>[<span class="string">"Value1"</span>.<span class="ident">to_string</span>(), <span class="string">"Value2"</span>.<span class="ident">to_string</span>()]);</pre> </div></div> - <h2 id='implementors'>Implementors</h2> + <h2 id='foreign-impls' class='small-section-header'> + Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a> + </h2> + <h3 id='impl-MailHeaderMap' class='impl'><span class='in-band'><code>impl<'a> <a class="trait" href="../mailparse/trait.MailHeaderMap.html" title="trait mailparse::MailHeaderMap">MailHeaderMap</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="../mailparse/struct.MailHeader.html" title="struct mailparse::MailHeader">MailHeader</a><'a>></code><a href='#impl-MailHeaderMap' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mailparse/lib.rs.html#418-437' title='goto source code'>[src]</a></span></h3> +<span class='docblock autohide'><div class='impl-items'><h4 id='method.get_first_value' class="method"><span id='get_first_value.v-1' class='invisible'><code>fn <a href='#method.get_first_value' class='fnname'>get_first_value</a>(&self, key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<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>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mailparse/lib.rs.html#419-426' title='goto source code'>[src]</a></span></h4> +<h4 id='method.get_all_values' class="method"><span id='get_all_values.v-1' class='invisible'><code>fn <a href='#method.get_all_values' class='fnname'>get_all_values</a>(&self, key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<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>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mailparse/lib.rs.html#428-436' title='goto source code'>[src]</a></span></h4> +</div></span> + <h2 id='implementors' class='small-section-header'> + Implementors<a href='#implementors' class='anchor'></a> + </h2> <ul class='item-list' id='implementors-list'> - <li><code>impl<'a> MailHeaderMap for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="../mailparse/struct.MailHeader.html" title="struct mailparse::MailHeader">MailHeader</a><'a>></code></li> -</ul><script type="text/javascript" async + </ul><script type="text/javascript" async src="../implementors/mailparse/trait.MailHeaderMap.js"> </script></section> <section id='search' class="content hidden"></section> @@ -105,18 +124,22 @@ case-insensitively.</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>⇤</dt> + <dt><kbd>↑</kbd></dt> <dd>Move up in search results</dd> - <dt>⇥</dt> + <dt><kbd>↓</kbd></dt> <dd>Move down in search results</dd> - <dt>⏎</dt> + <dt><kbd>↹</kbd></dt> + <dd>Switch tab</dd> + <dt><kbd>⏎</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> |