blob: 5f2e85394d511611674abc250fe24ab4bac514ce [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 `Args` trait in crate `quiche_apps`."><title>Args in quiche_apps::args - 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="#">Args</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.with_docopt">with_docopt</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In quiche_apps::args</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">args</a>::<wbr><a class="trait" href="#">Args</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/args.rs.html#29-31">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 Args {
// Required method
fn <a href="#tymethod.with_docopt" class="fn">with_docopt</a>(docopt: &amp;<a class="struct" href="http://burntsushi.net/rustdoc/docopt/docopt/dopt/struct.Docopt.html" title="struct docopt::dopt::Docopt">Docopt</a>) -&gt; Self;
}</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.with_docopt" class="method"><a class="src rightside" href="../../src/quiche_apps/args.rs.html#30">source</a><h4 class="code-header">fn <a href="#tymethod.with_docopt" class="fn">with_docopt</a>(docopt: &amp;<a class="struct" href="http://burntsushi.net/rustdoc/docopt/docopt/dopt/struct.Docopt.html" title="struct docopt::dopt::Docopt">Docopt</a>) -&gt; Self</h4></section></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-Args-for-ClientArgs" class="impl"><a class="src rightside" href="../../src/quiche_apps/args.rs.html#314-407">source</a><a href="#impl-Args-for-ClientArgs" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Args.html" title="trait quiche_apps::args::Args">Args</a> for <a class="struct" href="struct.ClientArgs.html" title="struct quiche_apps::args::ClientArgs">ClientArgs</a></h3></section><section id="impl-Args-for-CommonArgs" class="impl"><a class="src rightside" href="../../src/quiche_apps/args.rs.html#85-219">source</a><a href="#impl-Args-for-CommonArgs" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Args.html" title="trait quiche_apps::args::Args">Args</a> for <a class="struct" href="struct.CommonArgs.html" title="struct quiche_apps::args::CommonArgs">CommonArgs</a></h3></section><div class="docblock"><p>Creates a new <code>CommonArgs</code> structure using the provided <a href="https://docs.rs/docopt/1.1.0/docopt/"><code>Docopt</code></a>.</p>
<p>The <code>Docopt</code> usage String needs to include the following:</p>
<p>–http-version VERSION HTTP version to use.
–max-data BYTES Connection-wide flow control limit.
–max-window BYTES Connection-wide max receiver window.
–max-stream-data BYTES Per-stream flow control limit.
–max-stream-window BYTES Per-stream max receiver window.
–max-streams-bidi STREAMS Number of allowed concurrent streams.
–max-streams-uni STREAMS Number of allowed concurrent streams.
–dump-packets PATH Dump the incoming packets in PATH.
–no-grease Don’t send GREASE.
–cc-algorithm NAME Set a congestion control algorithm.
–disable-hystart Disable HyStart++.
–dgram-proto PROTO DATAGRAM application protocol.
–dgram-count COUNT Number of DATAGRAMs to send.
–dgram-data DATA DATAGRAM data to send.
–max-active-cids NUM Maximum number of active Connection IDs.
–enable-active-migration Enable active connection migration.
–max-field-section-size BYTES Max size of uncompressed field section.
–qpack-max-table-capacity BYTES Max capacity of dynamic QPACK decoding.
–qpack-blocked-streams STREAMS Limit of blocked streams while decoding.
–initial-cwnd-packets Size of initial congestion window, in packets.</p>
</div><section id="impl-Args-for-ServerArgs" class="impl"><a class="src rightside" href="../../src/quiche_apps/args.rs.html#483-509">source</a><a href="#impl-Args-for-ServerArgs" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Args.html" title="trait quiche_apps::args::Args">Args</a> for <a class="struct" href="struct.ServerArgs.html" title="struct quiche_apps::args::ServerArgs">ServerArgs</a></h3></section></div><script src="../../trait.impl/quiche_apps/args/trait.Args.js" async></script></section></div></main></body></html>