diff options
Diffstat (limited to 'target/doc/mailparse/trait.MailHeaderMap.html')
| -rw-r--r-- | target/doc/mailparse/trait.MailHeaderMap.html | 174 |
1 files changed, 0 insertions, 174 deletions
diff --git a/target/doc/mailparse/trait.MailHeaderMap.html b/target/doc/mailparse/trait.MailHeaderMap.html deleted file mode 100644 index 0d9fc06..0000000 --- a/target/doc/mailparse/trait.MailHeaderMap.html +++ /dev/null @@ -1,174 +0,0 @@ -<!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 `MailHeaderMap` trait in crate `mailparse`."> - <meta name="keywords" content="rust, rustlang, rust-lang, MailHeaderMap"> - - <title>mailparse::MailHeaderMap - 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> - - - - -</head> -<body class="rustdoc trait"> - <!--[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">☰</div> - - <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"> - <input class="search-input" name="search" - autocomplete="off" - placeholder="Click or press ‘S’ to search, ‘?’ for more options…" - type="search"> - </div> - </form> - </nav> - - <section id='main' class="content"><h1 class='fqn'><span class='in-band'>Trait <a href='index.html'>mailparse</a>::<wbr><a class="trait" href=''>MailHeaderMap</a></span><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'>−</span>] - </a> - </span><a class='srclink' href='../src/mailparse/lib.rs.html#385-419' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><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>>; -}</pre></div><div class='docblock'><p>A trait that is implemented by the Vec<MailHeader> returned by the parse_headers -function. It provides a map-like interface to look up header values by their -name.</p> -</div> - <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> -<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">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>, - <span class="string">"This is a test message"</span>).<span class="ident">as_bytes</span>()) - .<span class="ident">unwrap</span>().<span class="ident">headers</span>; - <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">headers</span>.<span class="ident">get_first_value</span>(<span class="string">"Subject"</span>).<span class="ident">unwrap</span>(), <span class="prelude-val">Some</span>(<span class="string">"Test"</span>.<span class="ident">to_string</span>()));</pre> -</div><h3 id='tymethod.get_all_values' class='method'><span id='get_all_values.v' class='invisible'><code>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>></code></span></h3><div class='docblock'><p>Look through the list of headers and return the values of all headers -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> -<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">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>()) - .<span class="ident">unwrap</span>().<span class="ident">headers</span>; - <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='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'><table class='table-display'><tbody><tr><td><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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mailparse/lib.rs.html#421-440' title='goto source code'>[src]</a></span></td></tr></tbody></table></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'><table class='table-display'><tbody><tr><td><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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mailparse/lib.rs.html#422-429' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.get_all_values' class="method"><span id='get_all_values.v-1' class='invisible'><table class='table-display'><tbody><tr><td><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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mailparse/lib.rs.html#431-439' title='goto source code'>[src]</a></td></tr></tbody></table></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'> - </ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async - src="../implementors/mailparse/trait.MailHeaderMap.js"> - </script></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>⏎</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> - </div> - </div> - </aside> - - - - <script> - window.rootPath = "../"; - window.currentCrate = "mailparse"; - </script> - <script src="../main.js"></script> - <script defer src="../search-index.js"></script> -</body> -</html>
\ No newline at end of file |