blob: 4a2bc001cf8ba81f73adcedcd33f44f753a320f2 [file] [log] [blame]
<!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="httparse"><meta name="keywords" content="rust, rustlang, rust-lang, httparse"><title>httparse - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="../crates.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../httparse/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../httparse/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate httparse</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 1.8.0</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><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></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Crate <a class="mod" href="#">httparse</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/httparse/lib.rs.html#1-2236">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><h2 id="httparse"><a href="#httparse">httparse</a></h2>
<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></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Header.html" title="httparse::Header struct">Header</a></div><div class="item-right docblock-short">Represents a parsed header.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.InvalidChunkSize.html" title="httparse::InvalidChunkSize struct">InvalidChunkSize</a></div><div class="item-right docblock-short">An error in parsing a chunk size.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ParserConfig.html" title="httparse::ParserConfig struct">ParserConfig</a></div><div class="item-right docblock-short">Parser configuration.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Request.html" title="httparse::Request struct">Request</a></div><div class="item-right docblock-short">A parsed Request.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Response.html" title="httparse::Response struct">Response</a></div><div class="item-right docblock-short">A parsed Response.</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Error.html" title="httparse::Error enum">Error</a></div><div class="item-right docblock-short">An error in parsing.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Status.html" title="httparse::Status enum">Status</a></div><div class="item-right docblock-short">The result of a successful parse pass.</div></div></div><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.EMPTY_HEADER.html" title="httparse::EMPTY_HEADER constant">EMPTY_HEADER</a></div><div class="item-right docblock-short">An empty header, useful for constructing a <code>Header</code> array to pass in for
parsing.</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.parse_chunk_size.html" title="httparse::parse_chunk_size fn">parse_chunk_size</a></div><div class="item-right docblock-short">Parse a buffer of bytes as a chunk size.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.parse_headers.html" title="httparse::parse_headers fn">parse_headers</a></div><div class="item-right docblock-short">Parse a buffer of bytes as headers.</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.Result.html" title="httparse::Result type">Result</a></div><div class="item-right docblock-short">A Result of any parsing action.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="httparse" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>