diff options
Diffstat (limited to 'target/doc/mailparse/trait.MailHeaderMap.html')
| -rw-r--r-- | target/doc/mailparse/trait.MailHeaderMap.html | 56 |
1 files changed, 27 insertions, 29 deletions
diff --git a/target/doc/mailparse/trait.MailHeaderMap.html b/target/doc/mailparse/trait.MailHeaderMap.html index 5e6f73a..792e93a 100644 --- a/target/doc/mailparse/trait.MailHeaderMap.html +++ b/target/doc/mailparse/trait.MailHeaderMap.html @@ -9,6 +9,7 @@ <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"> @@ -16,7 +17,7 @@ </head> -<body class="rustdoc"> +<body class="rustdoc trait"> <!--[if lte IE 8]> <div class="warning"> This old browser is unsupported and will most likely display funky @@ -28,7 +29,7 @@ <nav class="sidebar"> - <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="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> </nav> <nav class="sub"> @@ -42,53 +43,53 @@ </form> </nav> - <section id='main' class="content trait"> -<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'> + <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 id='src-231' class='srclink' href='../src/mailparse/src/lib.rs.html#366-400' title='goto source code'>[src]</a></span></h1> + </span><a class='srclink' href='../src/mailparse/lib.rs.html#366-400' 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>(&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='core::result::Result'>Result</a><<a class='enum' href='https://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a><<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>>; - 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='core::result::Result'>Result</a><<a class='struct' href='https://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html' title='collections::vec::Vec'>Vec</a><<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>>; + 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/collections/string/struct.String.html" title="struct collections::string::String">String</a>>, <a class="enum" href="../mailparse/enum.MailParseError.html" title="enum mailparse::MailParseError">MailParseError</a>>; + 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/collections/vec/struct.Vec.html" title="struct collections::vec::Vec">Vec</a><<a class="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::string::String">String</a>>, <a class="enum" href="../mailparse/enum.MailParseError.html" title="enum mailparse::MailParseError">MailParseError</a>>; }</pre><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'>Required Methods</h2> <div class='methods'> - <h3 id='tymethod.get_first_value' class='method stab '><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='core::result::Result'>Result</a><<a class='enum' href='https://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a><<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>></code></span></h3><div class='docblock'><p>Look through the list of headers and return the value of the first one + <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/collections/string/struct.String.html" title="struct collections::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>()));<a class='test-arrow' target='_blank' href=''>Run</a></pre> -</div><h3 id='tymethod.get_all_values' class='method stab '><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='core::result::Result'>Result</a><<a class='struct' href='https://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html' title='collections::vec::Vec'>Vec</a><<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>></code></span></h3><div class='docblock'><p>Look through the list of headers and return the values of all headers +<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/collections/vec/struct.Vec.html" title="struct collections::vec::Vec">Vec</a><<a class="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::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>()]);<a class='test-arrow' target='_blank' href=''>Run</a></pre> +<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='implementors'>Implementors</h2> <ul class='item-list' id='implementors-list'> - <li><code>impl<'a> MailHeaderMap for <a class='struct' href='https://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html' title='collections::vec::Vec'>Vec</a><<a class='struct' href='../mailparse/struct.MailHeader.html' title='mailparse::MailHeader'>MailHeader</a><'a>></code></li> + <li><code>impl<'a> MailHeaderMap for <a class="struct" href="https://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html" title="struct collections::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 src="../implementors/mailparse/trait.MailHeaderMap.js"> </script></section> @@ -147,11 +148,8 @@ case-insensitively.</p> <script> window.rootPath = "../"; window.currentCrate = "mailparse"; - window.playgroundUrl = ""; </script> - <script src="../jquery.js"></script> <script src="../main.js"></script> - <script defer src="../search-index.js"></script> </body> </html>
\ No newline at end of file |