summaryrefslogtreecommitdiffstats
path: root/target/doc/mailparse/fn.parse_content_type.html
diff options
context:
space:
mode:
authorKartikaya Gupta <kgupta@mozilla.com>2016-06-18 17:57:49 +0100
committerKartikaya Gupta <kgupta@mozilla.com>2016-06-18 17:57:53 +0100
commit812c2776ca90e32e2d4f3d1d7a40299af2b749b8 (patch)
tree41e1e5877af9ca18db8ad9564b3fa1c3bad32809 /target/doc/mailparse/fn.parse_content_type.html
parentb3bd1281a9a4639357de56d6bed63f69de2568c3 (diff)
Add generated documentation
Diffstat (limited to 'target/doc/mailparse/fn.parse_content_type.html')
-rw-r--r--target/doc/mailparse/fn.parse_content_type.html134
1 files changed, 134 insertions, 0 deletions
diff --git a/target/doc/mailparse/fn.parse_content_type.html b/target/doc/mailparse/fn.parse_content_type.html
new file mode 100644
index 0000000..db5e848
--- /dev/null
+++ b/target/doc/mailparse/fn.parse_content_type.html
@@ -0,0 +1,134 @@
+<!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 `parse_content_type` fn in crate `mailparse`.">
+ <meta name="keywords" content="rust, rustlang, rust-lang, parse_content_type">
+
+ <title>mailparse::parse_content_type - 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: 'parse_content_type', ty: 'fn', 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 fn">
+<h1 class='fqn'><span class='in-band'>Function <a href='index.html'>mailparse</a>::<wbr><a class='fn' href=''>parse_content_type</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'>&#x2212;</span>]
+ </a>
+ </span><a id='src-225' class='srclink' href='../src/mailparse/src/lib.rs.html#489-514' title='goto source code'>[src]</a></span></h1>
+<pre class='rust fn'>pub fn parse_content_type(header: &amp;<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a>&lt;<a class='struct' href='../mailparse/struct.ParsedContentType.html' title='mailparse::ParsedContentType'>ParsedContentType</a>, <a class='enum' href='../mailparse/enum.MailParseError.html' title='mailparse::MailParseError'>MailParseError</a>&gt;</pre><div class='docblock'><p>Helper method to parse a header value as a Content-Type header. The charset
+defaults to &quot;us-ascii&quot; if no charset parameter is provided in the header
+value.</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='ident'>parse_content_type</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&quot;Content-Type: text/html; charset=foo; boundary=\&quot;quotes_are_removed\&quot;&quot;</span>)
+ .<span class='ident'>unwrap</span>();
+ <span class='kw'>let</span> <span class='ident'>ctype</span> <span class='op'>=</span> <span class='ident'>parse_content_type</span>(<span class='kw-2'>&amp;</span><span class='ident'>parsed</span>.<span class='ident'>get_value</span>().<span class='ident'>unwrap</span>()).<span class='ident'>unwrap</span>();
+ <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>ctype</span>.<span class='ident'>mimetype</span>, <span class='string'>&quot;text/html&quot;</span>);
+ <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>ctype</span>.<span class='ident'>charset</span>, <span class='string'>&quot;foo&quot;</span>);
+ <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>ctype</span>.<span class='ident'>boundary</span>, <span class='prelude-val'>Some</span>(<span class='string'>&quot;quotes_are_removed&quot;</span>.<span class='ident'>to_string</span>()));</pre>
+
+<pre class='rust rust-example-rendered'>
+ <span class='kw'>use</span> <span class='ident'>mailparse</span>::{<span class='ident'>parse_header</span>, <span class='ident'>parse_content_type</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&quot;Content-Type: bogus&quot;</span>).<span class='ident'>unwrap</span>();
+ <span class='kw'>let</span> <span class='ident'>ctype</span> <span class='op'>=</span> <span class='ident'>parse_content_type</span>(<span class='kw-2'>&amp;</span><span class='ident'>parsed</span>.<span class='ident'>get_value</span>().<span class='ident'>unwrap</span>()).<span class='ident'>unwrap</span>();
+ <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>ctype</span>.<span class='ident'>mimetype</span>, <span class='string'>&quot;bogus&quot;</span>);
+ <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>ctype</span>.<span class='ident'>charset</span>, <span class='string'>&quot;us-ascii&quot;</span>);
+ <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>ctype</span>.<span class='ident'>boundary</span>, <span class='prelude-val'>None</span>);</pre>
+</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>&larrb;</dt>
+ <dd>Move up in search results</dd>
+ <dt>&rarrb;</dt>
+ <dd>Move down in search results</dd>
+ <dt>&#9166;</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
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-12 20:47:24 +0000