195 lines
10 KiB
HTML
195 lines
10 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 `frame` mod in crate `solicit`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, frame">
|
|||
|
|
|
|||
|
|
<title>solicit::http::frame - 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'>solicit</a>::<wbr><a href='../index.html'>http</a></p><script>window.sidebarCurrent = {name: 'frame', ty: 'mod', 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 mod">
|
|||
|
|
<h1 class='fqn'><span class='in-band'>Module <a href='../../index.html'>solicit</a>::<wbr><a href='../index.html'>http</a>::<wbr><a class='mod' href=''>frame</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 id='src-12' class='srclink' href='../../../src/solicit/http/frame/mod.rs.html#1-592' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<div class='docblock'><p>The module contains the implementation of HTTP/2 frames.</p>
|
|||
|
|
</div><h2 id='reexports' class='section-header'><a href="#reexports">Reexports</a></h2>
|
|||
|
|
<table><tr><td><code>pub use self::data::{<a class='enum' href='../../../solicit/http/frame/data/enum.DataFlag.html' title='solicit::http::frame::data::DataFlag'>DataFlag</a>, <a class='struct' href='../../../solicit/http/frame/data/struct.DataFrame.html' title='solicit::http::frame::data::DataFrame'>DataFrame</a>};</code></td></tr><tr><td><code>pub use self::headers::{<a class='enum' href='../../../solicit/http/frame/headers/enum.HeadersFlag.html' title='solicit::http::frame::headers::HeadersFlag'>HeadersFlag</a>, <a class='struct' href='../../../solicit/http/frame/headers/struct.HeadersFrame.html' title='solicit::http::frame::headers::HeadersFrame'>HeadersFrame</a>};</code></td></tr><tr><td><code>pub use self::settings::{<a class='enum' href='../../../solicit/http/frame/settings/enum.SettingsFlag.html' title='solicit::http::frame::settings::SettingsFlag'>SettingsFlag</a>, <a class='struct' href='../../../solicit/http/frame/settings/struct.SettingsFrame.html' title='solicit::http::frame::settings::SettingsFrame'>SettingsFrame</a>, <a class='enum' href='../../../solicit/http/frame/settings/enum.HttpSetting.html' title='solicit::http::frame::settings::HttpSetting'>HttpSetting</a>};</code></td></tr></table><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='mod' href='data/index.html'
|
|||
|
|
title='solicit::http::frame::data'>data</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>The module contains the implementation of the <code>DATA</code> frame and associated flags.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='mod' href='headers/index.html'
|
|||
|
|
title='solicit::http::frame::headers'>headers</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>The module contains the implementation of the <code>HEADERS</code> frame and associated flags.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='mod' href='settings/index.html'
|
|||
|
|
title='solicit::http::frame::settings'>settings</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>The module contains the implementation of the <code>SETTINGS</code> frame and associated flags.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='struct' href='struct.RawFrame.html'
|
|||
|
|
title='solicit::http::frame::RawFrame'>RawFrame</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>A struct that defines the format of the raw HTTP/2 frame, i.e. the frame
|
|||
|
|
as it is read from the wire.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='trait' href='trait.Flag.html'
|
|||
|
|
title='solicit::http::frame::Flag'>Flag</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>A trait that all HTTP/2 frame header flags need to implement.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='trait' href='trait.Frame.html'
|
|||
|
|
title='solicit::http::frame::Frame'>Frame</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>A trait that all HTTP/2 frame structs need to implement.</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.pack_header.html'
|
|||
|
|
title='solicit::http::frame::pack_header'>pack_header</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>Constructs a buffer of 9 bytes that represents the given <code>FrameHeader</code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='fn' href='fn.unpack_header.html'
|
|||
|
|
title='solicit::http::frame::unpack_header'>unpack_header</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>Deconstructs a <code>FrameHeader</code> into its corresponding 4 components,
|
|||
|
|
represented as a 4-tuple: <code>(length, frame_type, flags, stream_id)</code>.</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.FrameHeader.html'
|
|||
|
|
title='solicit::http::frame::FrameHeader'>FrameHeader</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>An alias for the 4-tuple representing the components of each HTTP/2 frame
|
|||
|
|
header.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class='type' href='type.FrameHeaderBuffer.html'
|
|||
|
|
title='solicit::http::frame::FrameHeaderBuffer'>FrameHeaderBuffer</a></td>
|
|||
|
|
<td class='docblock short'>
|
|||
|
|
<p>An alias for the 9-byte buffer that each HTTP/2 frame header must be stored
|
|||
|
|
in.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr></table></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>⇤</dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt>⇥</dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt>⏎</dt>
|
|||
|
|
<dd>Go to active search result</dd>
|
|||
|
|
<dt>+</dt>
|
|||
|
|
<dd>Collapse/expand 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 = "solicit";
|
|||
|
|
window.playgroundUrl = "";
|
|||
|
|
</script>
|
|||
|
|
<script src="../../../jquery.js"></script>
|
|||
|
|
<script src="../../../main.js"></script>
|
|||
|
|
|
|||
|
|
<script defer src="../../../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|