39 lines
5.6 KiB
HTML
39 lines
5.6 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="HTTP request types."><title>http::request - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="http" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module request</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../http/index.html">http</a><span class="version">1.4.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module request</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate http</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">http</a></div><h1>Module <span>request</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/http/request.rs.html#1-1068">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>HTTP request types.</p>
|
||
<p>This module contains structs related to HTTP requests, notably the
|
||
<code>Request</code> type itself as well as a builder to create requests. Typically
|
||
you’ll import the <code>http::Request</code> type rather than reaching into this
|
||
module itself.</p>
|
||
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
||
<p>Creating a <code>Request</code> to send</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>http::{Request, Response};
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>request = Request::builder()
|
||
.uri(<span class="string">"https://www.rust-lang.org/"</span>)
|
||
.header(<span class="string">"User-Agent"</span>, <span class="string">"my-awesome-agent/1.0"</span>);
|
||
|
||
<span class="kw">if </span>needs_awesome_header() {
|
||
request = request.header(<span class="string">"Awesome"</span>, <span class="string">"yes"</span>);
|
||
}
|
||
|
||
<span class="kw">let </span>response = send(request.body(()).unwrap());
|
||
|
||
<span class="kw">fn </span>send(req: Request<()>) -> Response<()> {
|
||
<span class="comment">// ...
|
||
</span>}</code></pre></div>
|
||
<p>Inspecting a request to see what was sent.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>http::{Request, Response, StatusCode};
|
||
|
||
<span class="kw">fn </span>respond_to(req: Request<()>) -> http::Result<Response<()>> {
|
||
<span class="kw">if </span>req.uri() != <span class="string">"/awesome-url" </span>{
|
||
<span class="kw">return </span>Response::builder()
|
||
.status(StatusCode::NOT_FOUND)
|
||
.body(())
|
||
}
|
||
|
||
<span class="kw">let </span>has_awesome_header = req.headers().contains_key(<span class="string">"Awesome"</span>);
|
||
<span class="kw">let </span>body = req.body();
|
||
|
||
<span class="comment">// ...
|
||
</span>}</code></pre></div></div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Builder.html" title="struct http::request::Builder">Builder</a></dt><dd>An HTTP request builder</dd><dt><a class="struct" href="struct.Parts.html" title="struct http::request::Parts">Parts</a></dt><dd>Component parts of an HTTP <code>Request</code></dd><dt><a class="struct" href="struct.Request.html" title="struct http::request::Request">Request</a></dt><dd>Represents an HTTP request.</dd></dl></section></div></main></body></html> |