blob: 13491b2e3a299763b5774f18e766935c8c0bc35a [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="API documentation for the Rust `HttpConn` trait in crate `quiche_apps`."><title>HttpConn in quiche_apps::common - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-b21aa549bf6d91ff.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="quiche_apps" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0-nightly (79734f1db 2024-05-02)" data-channel="nightly" data-search-js="search-bf21c90c8c1d92b1.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-e32f0c247825364d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-09095024cf37855e.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc trait"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../quiche_apps/index.html">quiche_apps</a><span class="version">0.1.0</span></h2></div><h2 class="location"><a href="#">HttpConn</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.handle_requests">handle_requests</a></li><li><a href="#tymethod.handle_responses">handle_responses</a></li><li><a href="#tymethod.handle_writable">handle_writable</a></li><li><a href="#tymethod.report_incomplete">report_incomplete</a></li><li><a href="#tymethod.send_requests">send_requests</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In quiche_apps::common</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../quiche_apps/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Type ‘S’ or ‘/’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings">Settings</a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="../index.html">quiche_apps</a>::<wbr><a href="index.html">common</a>::<wbr><a class="trait" href="#">HttpConn</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/quiche_apps/common.rs.html#336-359">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait HttpConn {
// Required methods
fn <a href="#tymethod.send_requests" class="fn">send_requests</a>(
&amp;mut self,
conn: &amp;mut <a class="struct" href="../../quiche/struct.Connection.html" title="struct quiche::Connection">Connection</a>,
target_path: &amp;<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;
);
<span class="item-spacer"></span> fn <a href="#tymethod.handle_responses" class="fn">handle_responses</a>(
&amp;mut self,
conn: &amp;mut <a class="struct" href="../../quiche/struct.Connection.html" title="struct quiche::Connection">Connection</a>,
buf: &amp;mut [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>],
req_start: &amp;<a class="struct" href="https://doc.rust-lang.org/nightly/std/time/struct.Instant.html" title="struct std::time::Instant">Instant</a>
);
<span class="item-spacer"></span> fn <a href="#tymethod.report_incomplete" class="fn">report_incomplete</a>(&amp;self, start: &amp;<a class="struct" href="https://doc.rust-lang.org/nightly/std/time/struct.Instant.html" title="struct std::time::Instant">Instant</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.handle_requests" class="fn">handle_requests</a>(
&amp;mut self,
conn: &amp;mut <a class="struct" href="../../quiche/struct.Connection.html" title="struct quiche::Connection">Connection</a>,
partial_requests: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, <a class="struct" href="struct.PartialRequest.html" title="struct quiche_apps::common::PartialRequest">PartialRequest</a>&gt;,
partial_responses: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, <a class="struct" href="struct.PartialResponse.html" title="struct quiche_apps::common::PartialResponse">PartialResponse</a>&gt;,
root: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
index: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
buf: &amp;mut [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]
) -&gt; <a class="type" href="../../quiche/h3/type.Result.html" title="type quiche::h3::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.handle_writable" class="fn">handle_writable</a>(
&amp;mut self,
conn: &amp;mut <a class="struct" href="../../quiche/struct.Connection.html" title="struct quiche::Connection">Connection</a>,
partial_responses: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, <a class="struct" href="struct.PartialResponse.html" title="struct quiche_apps::common::PartialResponse">PartialResponse</a>&gt;,
stream_id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>
);
}</code></pre><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><section id="tymethod.send_requests" class="method"><a class="src rightside" href="../../src/quiche_apps/common.rs.html#337-339">source</a><h4 class="code-header">fn <a href="#tymethod.send_requests" class="fn">send_requests</a>(&amp;mut self, conn: &amp;mut <a class="struct" href="../../quiche/struct.Connection.html" title="struct quiche::Connection">Connection</a>, target_path: &amp;<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;)</h4></section><section id="tymethod.handle_responses" class="method"><a class="src rightside" href="../../src/quiche_apps/common.rs.html#341-344">source</a><h4 class="code-header">fn <a href="#tymethod.handle_responses" class="fn">handle_responses</a>(
&amp;mut self,
conn: &amp;mut <a class="struct" href="../../quiche/struct.Connection.html" title="struct quiche::Connection">Connection</a>,
buf: &amp;mut [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>],
req_start: &amp;<a class="struct" href="https://doc.rust-lang.org/nightly/std/time/struct.Instant.html" title="struct std::time::Instant">Instant</a>
)</h4></section><section id="tymethod.report_incomplete" class="method"><a class="src rightside" href="../../src/quiche_apps/common.rs.html#346">source</a><h4 class="code-header">fn <a href="#tymethod.report_incomplete" class="fn">report_incomplete</a>(&amp;self, start: &amp;<a class="struct" href="https://doc.rust-lang.org/nightly/std/time/struct.Instant.html" title="struct std::time::Instant">Instant</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section><section id="tymethod.handle_requests" class="method"><a class="src rightside" href="../../src/quiche_apps/common.rs.html#348-353">source</a><h4 class="code-header">fn <a href="#tymethod.handle_requests" class="fn">handle_requests</a>(
&amp;mut self,
conn: &amp;mut <a class="struct" href="../../quiche/struct.Connection.html" title="struct quiche::Connection">Connection</a>,
partial_requests: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, <a class="struct" href="struct.PartialRequest.html" title="struct quiche_apps::common::PartialRequest">PartialRequest</a>&gt;,
partial_responses: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, <a class="struct" href="struct.PartialResponse.html" title="struct quiche_apps::common::PartialResponse">PartialResponse</a>&gt;,
root: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
index: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
buf: &amp;mut [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]
) -&gt; <a class="type" href="../../quiche/h3/type.Result.html" title="type quiche::h3::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;</h4></section><section id="tymethod.handle_writable" class="method"><a class="src rightside" href="../../src/quiche_apps/common.rs.html#355-358">source</a><h4 class="code-header">fn <a href="#tymethod.handle_writable" class="fn">handle_writable</a>(
&amp;mut self,
conn: &amp;mut <a class="struct" href="../../quiche/struct.Connection.html" title="struct quiche::Connection">Connection</a>,
partial_responses: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html" title="struct std::collections::hash::map::HashMap">HashMap</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, <a class="struct" href="struct.PartialResponse.html" title="struct quiche_apps::common::PartialResponse">PartialResponse</a>&gt;,
stream_id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>
)</h4></section></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-HttpConn-for-Http3Conn" class="impl"><a class="src rightside" href="../../src/quiche_apps/common.rs.html#1115-1642">source</a><a href="#impl-HttpConn-for-Http3Conn" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HttpConn.html" title="trait quiche_apps::common::HttpConn">HttpConn</a> for <a class="struct" href="struct.Http3Conn.html" title="struct quiche_apps::common::Http3Conn">Http3Conn</a></h3></section><section id="impl-HttpConn-for-Http09Conn" class="impl"><a class="src rightside" href="../../src/quiche_apps/common.rs.html#439-706">source</a><a href="#impl-HttpConn-for-Http09Conn" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HttpConn.html" title="trait quiche_apps::common::HttpConn">HttpConn</a> for <a class="struct" href="struct.Http09Conn.html" title="struct quiche_apps::common::Http09Conn">Http09Conn</a></h3></section></div><script src="../../trait.impl/quiche_apps/common/trait.HttpConn.js" async></script></section></div></main></body></html>