diff options
Diffstat (limited to 'target/doc/mailparse/struct.ParsedMail.html')
| -rw-r--r-- | target/doc/mailparse/struct.ParsedMail.html | 87 |
1 files changed, 56 insertions, 31 deletions
diff --git a/target/doc/mailparse/struct.ParsedMail.html b/target/doc/mailparse/struct.ParsedMail.html index 0925b0d..6d451a5 100644 --- a/target/doc/mailparse/struct.ParsedMail.html +++ b/target/doc/mailparse/struct.ParsedMail.html @@ -10,8 +10,11 @@ <title>mailparse::ParsedMail - 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'>Struct ParsedMail</p><div class="block items"><ul><li><a href="#fields">Fields</a></li><li><a href="#methods">Methods</a></li><li><a href="#implementations">Trait Implementations</a></li></ul></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> + <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></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"> @@ -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#644-654' title='goto source code'>[src]</a></span></h1> + </span><a class='srclink' href='../src/mailparse/lib.rs.html#643-653' title='goto source code'>[src]</a></span></h1> <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>, @@ -58,58 +69,68 @@ 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'>Fields</h2><span id='structfield.headers' class="structfield"> - <span id='headers.v' class='invisible'> +</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"> - <span id='ctype.v' class='invisible'> +</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"> - <span id='subparts.v' class='invisible'> +</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'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl<'a> <a class="struct" href="../mailparse/struct.ParsedMail.html" title="struct mailparse::ParsedMail">ParsedMail</a><'a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mailparse/lib.rs.html#656-734' title='goto source code'>[src]</a></span></h3> -<div class='impl-items'><h4 id='method.get_body' class="method"><span id='get_body.v' class='invisible'><code>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></h4> +</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'><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><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mailparse/lib.rs.html#655-733' title='goto source code'>[src]</a></span></h3> +<div class='impl-items'><h4 id='method.get_body' class="method"><span id='get_body.v' class='invisible'><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><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mailparse/lib.rs.html#671-680' title='goto source code'>[src]</a></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> +<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">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'><code>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></h4> +</div><h4 id='method.get_body_raw' class="method"><span id='get_body_raw.v' class='invisible'><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><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mailparse/lib.rs.html#696-719' title='goto source code'>[src]</a></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 +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> +<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">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'><code>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></h4> +</div><h4 id='method.get_content_disposition' class="method"><span id='get_content_disposition.v' class='invisible'><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><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mailparse/lib.rs.html#726-732' title='goto source code'>[src]</a></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'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mailparse/lib.rs.html#643' title='goto source code'>[src]</a></span></h3> -<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><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></h4> -<div class='docblock'><p>Formats the value using the given formatter.</p> +</div></div> + <h2 id='implementations' class='small-section-header'> + Trait Implementations<a href='#implementations' class='anchor'></a> + </h2> + <h3 id='impl-Debug' class='impl'><span class='in-band'><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><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mailparse/lib.rs.html#642' title='goto source code'>[src]</a></span></h3> +<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><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><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mailparse/lib.rs.html#642' title='goto source code'>[src]</a></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></section> <section id='search' class="content hidden"></section> @@ -123,18 +144,22 @@ returned object.</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> |