diff options
| author | Kartikaya Gupta <kgupta@mozilla.com> | 2016-06-18 17:57:49 +0100 |
|---|---|---|
| committer | Kartikaya Gupta <kgupta@mozilla.com> | 2016-06-18 17:57:53 +0100 |
| commit | 812c2776ca90e32e2d4f3d1d7a40299af2b749b8 (patch) | |
| tree | 41e1e5877af9ca18db8ad9564b3fa1c3bad32809 /target/doc/mailparse/struct.MailHeader.html | |
| parent | b3bd1281a9a4639357de56d6bed63f69de2568c3 (diff) | |
Add generated documentation
Diffstat (limited to 'target/doc/mailparse/struct.MailHeader.html')
| -rw-r--r-- | target/doc/mailparse/struct.MailHeader.html | 135 |
1 files changed, 135 insertions, 0 deletions
diff --git a/target/doc/mailparse/struct.MailHeader.html b/target/doc/mailparse/struct.MailHeader.html new file mode 100644 index 0000000..a5d1caa --- /dev/null +++ b/target/doc/mailparse/struct.MailHeader.html @@ -0,0 +1,135 @@ +<!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 `MailHeader` struct in crate `mailparse`."> + <meta name="keywords" content="rust, rustlang, rust-lang, MailHeader"> + + <title>mailparse::MailHeader - Rust</title> + + <link rel="stylesheet" type="text/css" href="../rustdoc.css"> + <link rel="stylesheet" type="text/css" href="../main.css"> + + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <nav class="sidebar"> + + <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> + </nav> + + <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 struct"> +<h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>mailparse</a>::<wbr><a class='struct' href=''>MailHeader</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-69' class='srclink' href='../src/mailparse/src/lib.rs.html#88-91' title='goto source code'>[src]</a></span></h1> +<pre class='rust struct'>pub struct MailHeader<'a> { + // some 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<'a> <a class='struct' href='../mailparse/struct.MailHeader.html' title='mailparse::MailHeader'>MailHeader</a><'a></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>(&self) -> <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/string/struct.String.html' title='collections::string::String'>String</a>, <a class='enum' href='../mailparse/enum.MailParseError.html' title='mailparse::MailParseError'>MailParseError</a>></code></h4> +<div class='docblock'><p>Get the name of the header. Note that header names are case-sensitive.</p> +</div><h4 id='method.get_value' class='method'><code>fn <a href='#method.get_value' class='fnname'>get_value</a>(&self) -> <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/string/struct.String.html' title='collections::string::String'>String</a>, <a class='enum' href='../mailparse/enum.MailParseError.html' title='mailparse::MailParseError'>MailParseError</a>></code></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> +<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'>let</span> (<span class='ident'>parsed</span>, _) <span class='op'>=</span> <span class='ident'>parse_header</span>(<span class='string'>b"Subject: =?iso-8859-1?Q?=A1Hola,_se=F1or!?="</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'>"Subject"</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'>"\u{a1}Hola, se\u{f1}or!"</span>);</pre> +</div></div><h2 id='implementations'>Trait Implementations</h2><h3 id='derived_implementations'>Derived Implementations </h3><h3 class='impl'><code>impl<'a> <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><'a></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>(&self, __arg_0: &mut <a class='struct' href='https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html' title='core::fmt::Formatter'>Formatter</a>) -> <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> + <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>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</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"; + 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 |