diff options
Diffstat (limited to 'target/doc/mailparse/struct.ParsedMail.html')
| -rw-r--r-- | target/doc/mailparse/struct.ParsedMail.html | 80 |
1 files changed, 39 insertions, 41 deletions
diff --git a/target/doc/mailparse/struct.ParsedMail.html b/target/doc/mailparse/struct.ParsedMail.html index 3b84561..b2b6cd8 100644 --- a/target/doc/mailparse/struct.ParsedMail.html +++ b/target/doc/mailparse/struct.ParsedMail.html @@ -9,6 +9,7 @@ <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"> @@ -16,7 +17,7 @@ </head> -<body class="rustdoc"> +<body class="rustdoc struct"> <!--[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: 'ParsedMail', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script> + <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> </nav> <nav class="sub"> @@ -42,66 +43,66 @@ </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=''>ParsedMail</a></span><span class='out-of-band'><span id='render-detail'> + <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 id='src-287' class='srclink' href='../src/mailparse/src/lib.rs.html#558-568' title='goto source code'>[src]</a></span></h1> + </span><a class='srclink' href='../src/mailparse/lib.rs.html#558-568' 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/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>>, - pub ctype: <a class='struct' href='../mailparse/struct.ParsedContentType.html' title='mailparse::ParsedContentType'>ParsedContentType</a>, - pub subparts: <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.ParsedMail.html' title='mailparse::ParsedMail'>ParsedMail</a><'a>>, + pub headers: <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>>, + 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/collections/vec/struct.Vec.html" title="struct collections::vec::Vec">Vec</a><<a class="struct" href="../mailparse/struct.ParsedMail.html" title="struct mailparse::ParsedMail">ParsedMail</a><'a>>, // some fields omitted }</pre><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 class='fields'>Fields</h2><span id='structfield.headers' class='structfield'> +</div><h2 id='fields' class='fields'>Fields</h2><span id='structfield.headers' class="structfield"> <span id='headers.v' class='invisible'> - <code>headers: <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> - </span></span><span class='stab '></span><div class='docblock'><p>The headers for the message (or message subpart).</p> -</div><span id='structfield.ctype' class='structfield'> + <code>headers: <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> + </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'> - <code>ctype: <a class='struct' href='../mailparse/struct.ParsedContentType.html' title='mailparse::ParsedContentType'>ParsedContentType</a></code> - </span></span><span class='stab '></span><div class='docblock'><p>The Content-Type information for the message (or message subpart).</p> -</div><span id='structfield.subparts' class='structfield'> + <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'> - <code>subparts: <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.ParsedMail.html' title='mailparse::ParsedMail'>ParsedMail</a><'a>></code> - </span></span><span class='stab '></span><div class='docblock'><p>The subparts of this message or subpart. This vector is only non-empty + <code>subparts: <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.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='mailparse::ParsedMail'>ParsedMail</a><'a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-303' class='srclink' href='../src/mailparse/src/lib.rs.html#570-629' 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='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></span></h4> +</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#570-629' 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/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></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>);<a class='test-arrow' target='_blank' href=''>Run</a></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='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='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u8.html'>u8</a>>, <a class='enum' href='../mailparse/enum.MailParseError.html' title='mailparse::MailParseError'>MailParseError</a>></code></span></h4> +<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'><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/collections/vec/struct.Vec.html" title="struct collections::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 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>);<a class='test-arrow' target='_blank' href=''>Run</a></pre> -</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='core::fmt::Debug'>Debug</a> for <a class='struct' href='../mailparse/struct.ParsedMail.html' title='mailparse::ParsedMail'>ParsedMail</a><'a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-293' class='srclink' href='../src/mailparse/src/lib.rs.html#557' 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='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></span></h4> +<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></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#557' 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></section> <section id='search' class="content hidden"></section> @@ -159,11 +160,8 @@ any charset decoding.</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 |