diff options
Diffstat (limited to 'target/doc/mailparse/struct.ParsedMail.html')
| -rw-r--r-- | target/doc/mailparse/struct.ParsedMail.html | 197 |
1 files changed, 0 insertions, 197 deletions
diff --git a/target/doc/mailparse/struct.ParsedMail.html b/target/doc/mailparse/struct.ParsedMail.html deleted file mode 100644 index 3d97dfd..0000000 --- a/target/doc/mailparse/struct.ParsedMail.html +++ /dev/null @@ -1,197 +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 `ParsedMail` struct in crate `mailparse`."> - <meta name="keywords" content="rust, rustlang, rust-lang, ParsedMail"> - - <title>mailparse::ParsedMail - 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 struct"> - <!--[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'>Struct ParsedMail</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#fields">Fields</a><div class="sidebar-links"><a href="#structfield.headers">headers</a><a href="#structfield.ctype">ctype</a><a href="#structfield.subparts">subparts</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.get_body">get_body</a><a href="#method.get_body_raw">get_body_raw</a><a href="#method.get_content_disposition">get_content_disposition</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='index.html'>mailparse</a></p><script>window.sidebarCurrent = {name: 'ParsedMail', ty: 'struct', 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'>Struct <a href='index.html'>mailparse</a>::<wbr><a class="struct" href=''>ParsedMail</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#646-656' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct ParsedMail<'a> { - pub headers: <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>>, - pub ctype: <a class="struct" href="../mailparse/struct.ParsedContentType.html" title="struct mailparse::ParsedContentType">ParsedContentType</a>, - pub subparts: <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.ParsedMail.html" title="struct mailparse::ParsedMail">ParsedMail</a><'a>>, - // some fields omitted -}</pre></div><div class='docblock'><p>Struct that holds the structured representation of the message. Note that -since MIME allows for nested multipart messages, a tree-like structure is -necessary to represent it properly. This struct accomplishes that by holding -a vector of other ParsedMail structures for the subparts.</p> -</div><h2 id='fields' class='fields small-section-header'> - Fields<a href='#fields' class='anchor'></a></h2><span id="structfield.headers" class="structfield small-section-header"> - <a href="#structfield.headers" class="anchor field"></a> - <span id="headers.v" class='invisible'> - <code>headers: <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> - </span></span><div class='docblock'><p>The headers for the message (or message subpart).</p> -</div><span id="structfield.ctype" class="structfield small-section-header"> - <a href="#structfield.ctype" class="anchor field"></a> - <span id="ctype.v" class='invisible'> - <code>ctype: <a class="struct" href="../mailparse/struct.ParsedContentType.html" title="struct mailparse::ParsedContentType">ParsedContentType</a></code> - </span></span><div class='docblock'><p>The Content-Type information for the message (or message subpart).</p> -</div><span id="structfield.subparts" class="structfield small-section-header"> - <a href="#structfield.subparts" class="anchor field"></a> - <span id="subparts.v" class='invisible'> - <code>subparts: <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.ParsedMail.html" title="struct mailparse::ParsedMail">ParsedMail</a><'a>></code> - </span></span><div class='docblock'><p>The subparts of this message or subpart. This vector is only non-empty -if ctype.mimetype starts with "multipart/".</p> -</div> - <h2 id='methods' class='small-section-header'> - Methods<a href='#methods' class='anchor'></a> - </h2> - <h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a> <a class="struct" href="../mailparse/struct.ParsedMail.html" title="struct mailparse::ParsedMail">ParsedMail</a><'a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mailparse/lib.rs.html#658-736' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.get_body' class="method"><span id='get_body.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.get_body' class='fnname'>get_body</a>(&self) -> <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/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#674-683' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Get the body of the message as a Rust string. This function tries to -unapply the Content-Transfer-Encoding if there is one, and then converts -the result into a Rust UTF-8 string using the charset in the Content-Type -(or "us-ascii" if the charset was missing or not recognized).</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="kw">let</span> <span class="ident">p</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 the body"</span>).<span class="ident">as_bytes</span>()) - .<span class="ident">unwrap</span>(); - <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">p</span>.<span class="ident">get_body</span>().<span class="ident">unwrap</span>(), <span class="string">"This is the body"</span>);</pre> -</div><h4 id='method.get_body_raw' class="method"><span id='get_body_raw.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.get_body_raw' class='fnname'>get_body_raw</a>(&self) -> <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</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#699-722' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Get the body of the message as a Rust Vec<u8>. This function tries to -unapply the Content-Transfer-Encoding if there is one, but won't do -any charset decoding.</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="kw">let</span> <span class="ident">p</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 the body"</span>).<span class="ident">as_bytes</span>()) - .<span class="ident">unwrap</span>(); - <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">p</span>.<span class="ident">get_body_raw</span>().<span class="ident">unwrap</span>(), <span class="string">b"This is the body"</span>);</pre> -</div><h4 id='method.get_content_disposition' class="method"><span id='get_content_disposition.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.get_content_disposition' class='fnname'>get_content_disposition</a>(<br> &self<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="struct" href="../mailparse/struct.ParsedContentDisposition.html" title="struct mailparse::ParsedContentDisposition">ParsedContentDisposition</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#729-735' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a struct containing a parsed representation of the -Content-Disposition header. The first header with this name -is used, if there are multiple. See the <code>parse_content_disposition</code> -method documentation for more details on the semantics of the -returned object.</p> -</div></div> - <h2 id='implementations' class='small-section-header'> - Trait Implementations<a href='#implementations' class='anchor'></a> - </h2> - <div id='implementations-list'> - <h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../mailparse/struct.ParsedMail.html" title="struct mailparse::ParsedMail">ParsedMail</a><'a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mailparse/lib.rs.html#645' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><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="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mailparse/lib.rs.html#645' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p> -</div></div></div> - <h2 id='synthetic-implementations' class='small-section-header'> - Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a> - </h2> - <div id='synthetic-implementations-list'> - <h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../mailparse/struct.ParsedMail.html" title="struct mailparse::ParsedMail">ParsedMail</a><'a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../mailparse/struct.ParsedMail.html" title="struct mailparse::ParsedMail">ParsedMail</a><'a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></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><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 |