summaryrefslogtreecommitdiffstats
path: root/target/doc/mailparse/fn.parse_headers.html
diff options
context:
space:
mode:
Diffstat (limited to 'target/doc/mailparse/fn.parse_headers.html')
-rw-r--r--target/doc/mailparse/fn.parse_headers.html32
1 files changed, 15 insertions, 17 deletions
diff --git a/target/doc/mailparse/fn.parse_headers.html b/target/doc/mailparse/fn.parse_headers.html
index 367c1c3..317c90e 100644
--- a/target/doc/mailparse/fn.parse_headers.html
+++ b/target/doc/mailparse/fn.parse_headers.html
@@ -9,6 +9,7 @@
<title>mailparse::parse_headers - 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 fn">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
@@ -42,13 +43,13 @@
</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_headers</a></span><span class='out-of-band'><span id='render-detail'>
+ <section id='main' class="content">
+<h1 class='fqn'><span class='in-band'>Function <a href='index.html'>mailparse</a>::<wbr><a class="fn" href=''>parse_headers</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-257' class='srclink' href='../src/mailparse/src/lib.rs.html#446-469' title='goto source code'>[src]</a></span></h1>
-<pre class='rust fn'>pub fn parse_headers(raw_data: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>&amp;[</a><a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u8.html'>u8</a><a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>]</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='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>(</a><a class='struct' href='https://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html' title='collections::vec::Vec'>Vec</a>&lt;<a class='struct' href='../mailparse/struct.MailHeader.html' title='mailparse::MailHeader'>MailHeader</a>&gt;, <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.usize.html'>usize</a><a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>)</a>,&nbsp;<a class='enum' href='../mailparse/enum.MailParseError.html' title='mailparse::MailParseError'>MailParseError</a>&gt;</pre><div class='docblock'><p>Parses all the headers from the raw data given.
+ </span><a class='srclink' href='../src/mailparse/lib.rs.html#446-469' title='goto source code'>[src]</a></span></h1>
+<pre class='rust fn'>pub fn parse_headers(<br>&nbsp;&nbsp;&nbsp;&nbsp;raw_data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="https://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html" title="struct collections::vec::Vec">Vec</a>&lt;<a class="struct" href="../mailparse/struct.MailHeader.html" title="struct mailparse::MailHeader">MailHeader</a>&gt;, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="enum" href="../mailparse/enum.MailParseError.html" title="enum mailparse::MailParseError">MailParseError</a>&gt;</pre><div class='docblock'><p>Parses all the headers from the raw data given.
This function takes raw byte data, and starts parsing it, expecting there
to be zero or more MIME header key-value pair right at the beginning,
followed by two consecutive newlines (i.e. a blank line). It parses those
@@ -61,15 +62,15 @@ returned tuple.
Error values are returned if there was some sort of parsing error.</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_headers</span>, <span class='ident'>MailHeaderMap</span>};
- <span class='kw'>let</span> (<span class='ident'>headers</span>, _) <span class='op'>=</span> <span class='ident'>parse_headers</span>(<span class='macro'>concat</span><span class='macro'>!</span>(
- <span class='string'>&quot;Subject: Test\n&quot;</span>,
- <span class='string'>&quot;From: me@myself.com\n&quot;</span>,
- <span class='string'>&quot;To: you@yourself.com&quot;</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'>headers</span>[<span class='number'>1</span>].<span class='ident'>get_key</span>().<span class='ident'>unwrap</span>(), <span class='string'>&quot;From&quot;</span>);
- <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>headers</span>.<span class='ident'>get_first_value</span>(<span class='string'>&quot;To&quot;</span>).<span class='ident'>unwrap</span>(), <span class='prelude-val'>Some</span>(<span class='string'>&quot;you@yourself.com&quot;</span>.<span class='ident'>to_string</span>()));<a class='test-arrow' target='_blank' href=''>Run</a></pre>
+<pre class="rust rust-example-rendered">
+<span class="kw">use</span> <span class="ident">mailparse</span>::{<span class="ident">parse_headers</span>, <span class="ident">MailHeaderMap</span>};
+ <span class="kw">let</span> (<span class="ident">headers</span>, _) <span class="op">=</span> <span class="ident">parse_headers</span>(<span class="macro">concat</span><span class="macro">!</span>(
+ <span class="string">&quot;Subject: Test\n&quot;</span>,
+ <span class="string">&quot;From: me@myself.com\n&quot;</span>,
+ <span class="string">&quot;To: you@yourself.com&quot;</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">headers</span>[<span class="number">1</span>].<span class="ident">get_key</span>().<span class="ident">unwrap</span>(), <span class="string">&quot;From&quot;</span>);
+ <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">headers</span>.<span class="ident">get_first_value</span>(<span class="string">&quot;To&quot;</span>).<span class="ident">unwrap</span>(), <span class="prelude-val">Some</span>(<span class="string">&quot;you@yourself.com&quot;</span>.<span class="ident">to_string</span>()));</pre>
</div></section>
<section id='search' class="content hidden"></section>
@@ -126,11 +127,8 @@ Error values are returned if there was some sort of parsing error.</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