31 lines
6.4 KiB
HTML
31 lines
6.4 KiB
HTML
<!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 `httparse` crate."><meta name="keywords" content="rust, rustlang, rust-lang, httparse"><title>httparse - 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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[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><a href='../httparse/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate httparse</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all httparse's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'httparse', ty: 'mod', relpath: '../'};</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"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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/httparse/lib.rs.html#1-1152' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>httparse</a></span></h1><div class='docblock'><h1 id="httparse" class="section-header"><a href="#httparse">httparse</a></h1>
|
||
<p>A push library for parsing HTTP/1.x requests and responses.</p>
|
||
<p>The focus is on speed and safety. Unsafe code is used to keep parsing fast,
|
||
but unsafety is contained in a submodule, with invariants enforced. The
|
||
parsing internals use an <code>Iterator</code> instead of direct indexing, while
|
||
skipping bounds checks.</p>
|
||
<p>With Rust 1.27.0 or later, support for SIMD is enabled automatically.
|
||
If building an executable to be run on multiple platforms, and thus
|
||
not passing <code>target_feature</code> or <code>target_cpu</code> flags to the compiler,
|
||
runtime detection can still detect SSE4.2 or AVX2 support to provide
|
||
massive wins.</p>
|
||
<p>If compiling for a specific target, remembering to include
|
||
<code>-C target_cpu=native</code> allows the detection to become compile time checks,
|
||
making it <em>even</em> faster.</p>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table><tr class='module-item'><td><a class="struct" href="struct.Header.html" title='httparse::Header struct'>Header</a></td><td class='docblock-short'><p>Represents a parsed header.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.InvalidChunkSize.html" title='httparse::InvalidChunkSize struct'>InvalidChunkSize</a></td><td class='docblock-short'><p>An error in parsing a chunk size.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Request.html" title='httparse::Request struct'>Request</a></td><td class='docblock-short'><p>A parsed Request.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Response.html" title='httparse::Response struct'>Response</a></td><td class='docblock-short'><p>A parsed Response.</p>
|
||
</td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
||
<table><tr class='module-item'><td><a class="enum" href="enum.Error.html" title='httparse::Error enum'>Error</a></td><td class='docblock-short'><p>An error in parsing.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.Status.html" title='httparse::Status enum'>Status</a></td><td class='docblock-short'><p>The result of a successful parse pass.</p>
|
||
</td></tr></table><h2 id='constants' class='section-header'><a href="#constants">Constants</a></h2>
|
||
<table><tr class='module-item'><td><a class="constant" href="constant.EMPTY_HEADER.html" title='httparse::EMPTY_HEADER constant'>EMPTY_HEADER</a></td><td class='docblock-short'><p>An empty header, useful for constructing a <code>Header</code> array to pass in for
|
||
parsing.</p>
|
||
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table><tr class='module-item'><td><a class="fn" href="fn.parse_chunk_size.html" title='httparse::parse_chunk_size fn'>parse_chunk_size</a></td><td class='docblock-short'><p>Parse a buffer of bytes as a chunk size.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.parse_headers.html" title='httparse::parse_headers fn'>parse_headers</a></td><td class='docblock-short'><p>Parse a buffer of bytes as headers.</p>
|
||
</td></tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
||
<table><tr class='module-item'><td><a class="type" href="type.Result.html" title='httparse::Result type'>Result</a></td><td class='docblock-short'><p>A Result of any parsing action.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "httparse";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |