diff options
Diffstat (limited to 'target/doc/mailparse/fn.parse_headers.html')
-rw-r--r-- | target/doc/mailparse/fn.parse_headers.html | 147 |
1 files changed, 0 insertions, 147 deletions
diff --git a/target/doc/mailparse/fn.parse_headers.html b/target/doc/mailparse/fn.parse_headers.html deleted file mode 100644 index 6067747..0000000 --- a/target/doc/mailparse/fn.parse_headers.html +++ /dev/null @@ -1,147 +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 `parse_headers` fn in crate `mailparse`."> - <meta name="keywords" content="rust, rustlang, rust-lang, parse_headers"> - - <title>mailparse::parse_headers - 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 fn"> - <!--[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> - - <div class="sidebar-elems"><p class='location'><a href='index.html'>mailparse</a></p><script>window.sidebarCurrent = {name: 'parse_headers', ty: 'fn', 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'>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'>−</span>] - </a> - </span><a class='srclink' href='../src/mailparse/lib.rs.html#465-490' title='goto source code'>[src]</a></span></h1><pre class='rust fn'>pub fn parse_headers(<br> raw_data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</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>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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/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 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>></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 -headers and returns them in a vector. The normal vector functions can be -used to access the headers linearly, or the MailHeaderMap trait can be used -to access them in a map-like fashion. Along with this vector, the function -returns the index at which the message body is expected to start. If you -just care about the headers, you can ignore the second component of the -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="kw">_</span>) <span class="op">=</span> <span class="ident">parse_headers</span>(<span class="macro">concat</span><span class="macro">!</span>( - <span class="string">"Subject: Test\n"</span>, - <span class="string">"From: me@myself.com\n"</span>, - <span class="string">"To: you@yourself.com"</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">"From"</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">"To"</span>).<span class="ident">unwrap</span>(), <span class="prelude-val">Some</span>(<span class="string">"you@yourself.com"</span>.<span class="ident">to_string</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><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 |