http-rs
/
http-types
mirror of https://github.com/http-rs/http-types
1
0
Fork 0
Code Issues Releases Wiki Activity

Merge pull request #324 from http-rs/simplify-request-examples 

Simplify Request examples
This commit is contained in:
Yoshua Wuyts 2021-01-23 16:41:35 +01:00 committed by GitHub
parent c432783515 667ecba1e6
commit e3801d0f43
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 46 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/lib.rs
View File

@ -8,9 +8,9 @@
//! ```
//! # fn main() -> Result<(), http_types::url::ParseError> {
//! #
//! use http_types::{Url, Method, Request, Response, StatusCode};
//! use http_types::{Method, Request, Response, StatusCode};
//!
//! let mut req = Request::new(Method::Get, Url::parse("https://example.com")?);
//! let mut req = Request::new(Method::Get, "https://example.com");
//! req.set_body("Hello, Nori!");
//!
//! let mut res = Response::new(StatusCode::Ok);

94
src/request.rs
View File

@ -21,9 +21,9 @@ pin_project_lite::pin_project! {
/// # Examples
///
/// ```
/// use http_types::{Url, Method, Request};
/// use http_types::Request;
///
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com").unwrap());
/// let mut req = Request::get("https://example.com");
/// req.set_body("Hello, Nori!");
/// ```
#[derive(Debug)]
@ -157,8 +157,8 @@ impl Request {
/// ```
/// # fn main() -> Result<(), http_types::Error> {
/// #
/// use http_types::{Method, Request, Response, StatusCode, Url};
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?);
/// use http_types::{Request, Response, StatusCode};
/// let mut req = Request::get("https://example.com");
/// assert_eq!(req.url().scheme(), "https");
/// #
/// # Ok(()) }
@ -175,7 +175,7 @@ impl Request {
/// # fn main() -> Result<(), http_types::Error> {
/// #
/// use http_types::{Method, Request, Response, StatusCode, Url};
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?);
/// let mut req = Request::get("https://example.com");
/// req.url_mut().set_scheme("http");
/// assert_eq!(req.url().scheme(), "http");
/// #
@ -190,9 +190,9 @@ impl Request {
/// # Examples
///
/// ```
/// use http_types::{Method, Request, Url};
/// use http_types::{Method, Request};
///
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com").unwrap());
/// let mut req = Request::get("https://example.com");
/// req.set_body("Hello, Nori!");
/// ```
pub fn set_body(&mut self, body: impl Into<Body>) {
@ -208,9 +208,9 @@ impl Request {
/// # use async_std::io::prelude::*;
/// # fn main() -> http_types::Result<()> { async_std::task::block_on(async {
/// #
/// use http_types::{Body, Method, Request, Url};
/// use http_types::{Body, Method, Request};
///
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com").unwrap());
/// let mut req = Request::get("https://example.com");
/// req.set_body("Hello, Nori!");
/// let mut body: Body = req.replace_body("Hello, Chashu!");
///
@ -234,9 +234,9 @@ impl Request {
/// # use async_std::io::prelude::*;
/// # fn main() -> http_types::Result<()> { async_std::task::block_on(async {
/// #
/// use http_types::{Body, Method, Request, Url};
/// use http_types::{Body, Request};
///
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com").unwrap());
/// let mut req = Request::get("https://example.com");
/// req.set_body("Hello, Nori!");
/// let mut body = "Hello, Chashu!".into();
/// req.swap_body(&mut body);
@ -260,9 +260,9 @@ impl Request {
/// # use async_std::io::prelude::*;
/// # fn main() -> http_types::Result<()> { async_std::task::block_on(async {
/// #
/// use http_types::{Body, Method, Request, Url};
/// use http_types::{Body, Request};
///
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com").unwrap());
/// let mut req = Request::get("https://example.com");
/// req.set_body("Hello, Nori!");
/// let mut body: Body = req.take_body();
///
@ -293,9 +293,9 @@ impl Request {
/// # use std::io::prelude::*;
/// # fn main() -> http_types::Result<()> { async_std::task::block_on(async {
/// use async_std::io::Cursor;
/// use http_types::{Body, Method, Request, Url};
/// use http_types::{Body, Request};
///
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com").unwrap());
/// let mut req = Request::get("https://example.com");
///
/// let cursor = Cursor::new("Hello Nori");
/// let body = Body::from_reader(cursor, None);
@ -319,10 +319,10 @@ impl Request {
///
/// ```
/// # fn main() -> http_types::Result<()> { async_std::task::block_on(async {
/// use http_types::{Body, Method, Request, Url};
/// use http_types::{Body, Request};
///
/// let bytes = vec![1, 2, 3];
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com").unwrap());
/// let mut req = Request::get("https://example.com");
/// req.set_body(Body::from_bytes(bytes));
///
/// let bytes = req.body_bytes().await?;
@ -346,7 +346,7 @@ impl Request {
/// ```
/// # fn main() -> http_types::Result<()> { async_std::task::block_on(async {
/// use http_types::convert::{Deserialize, Serialize};
/// use http_types::{Body, Method, Request, Url};
/// use http_types::{Body, Request};
///
/// #[derive(Debug, Serialize, Deserialize)]
/// struct Cat {
@ -356,7 +356,7 @@ impl Request {
/// let cat = Cat {
/// name: String::from("chashu"),
/// };
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com").unwrap());
/// let mut req = Request::get("https://example.com");
/// req.set_body(Body::from_json(&cat)?);
///
/// let cat: Cat = req.body_json().await?;
@ -380,7 +380,7 @@ impl Request {
/// ```
/// # fn main() -> http_types::Result<()> { async_std::task::block_on(async {
/// use http_types::convert::{Deserialize, Serialize};
/// use http_types::{Body, Method, Request, Url};
/// use http_types::{Body, Request};
///
/// #[derive(Debug, Serialize, Deserialize)]
/// struct Cat {
@ -390,7 +390,7 @@ impl Request {
/// let cat = Cat {
/// name: String::from("chashu"),
/// };
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com").unwrap());
/// let mut req = Request::get("https://example.com");
/// req.set_body(Body::from_form(&cat)?);
///
/// let cat: Cat = req.body_form().await?;
@ -424,9 +424,9 @@ impl Request {
/// ```
/// # fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
/// #
/// use http_types::{Method, Request, Url};
/// use http_types::Request;
///
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?);
/// let mut req = Request::get("https://example.com");
/// req.insert_header("Content-Type", "text/plain");
/// #
/// # Ok(()) }
@ -450,9 +450,9 @@ impl Request {
/// ```
/// # fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
/// #
/// use http_types::{Method, Request, Url};
/// use http_types::Request;
///
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?);
/// let mut req = Request::get("https://example.com");
/// req.append_header("Content-Type", "text/plain");
/// #
/// # Ok(()) }
@ -503,11 +503,11 @@ impl Request {
/// # Examples
///
/// ```
/// use http_types::{Method, Request, Url, Version};
/// use http_types::{Request, Version};
///
/// # fn main() -> Result<(), http_types::Error> {
/// #
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?);
/// let mut req = Request::get("https://example.com");
/// assert_eq!(req.version(), None);
///
/// req.set_version(Some(Version::Http2_0));
@ -524,11 +524,11 @@ impl Request {
/// # Examples
///
/// ```
/// use http_types::{Method, Request, Url, Version};
/// use http_types::{Request, Version};
///
/// # fn main() -> Result<(), http_types::Error> {
/// #
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?);
/// let mut req = Request::get("https://example.com");
/// req.set_version(Some(Version::Http2_0));
/// #
/// # Ok(()) }
@ -594,9 +594,9 @@ impl Request {
/// ```
/// # fn main() -> Result<(), http_types::Error> {
/// #
/// use http_types::{Method, Request, Url, Version};
/// use http_types::{Request, Version};
///
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?);
/// let mut req = Request::get("https://example.com");
/// req.ext_mut().insert("hello from the extension");
/// assert_eq!(req.ext().get(), Some(&"hello from the extension"));
/// #
@ -612,7 +612,7 @@ impl Request {
///
/// ```
/// use http_types::convert::Deserialize;
/// use http_types::{Method, Request, Url};
/// use http_types::Request;
/// use std::collections::HashMap;
///
/// #[derive(Deserialize)]
@ -621,10 +621,7 @@ impl Request {
/// selections: HashMap<String, String>,
/// }
///
/// let req = Request::new(
/// Method::Get,
/// Url::parse("https://httpbin.org/get?page=2&selections[width]=narrow&selections[height]=tall").unwrap(),
/// );
/// let mut req = Request::get("https://httpbin.org/get?page=2&selections[width]=narrow&selections[height]=tall");
/// let Index { page, selections } = req.query().unwrap();
/// assert_eq!(page, 2);
/// assert_eq!(selections["width"], "narrow");
@ -648,7 +645,7 @@ impl Request {
///
/// ```
/// use http_types::convert::Serialize;
/// use http_types::{Method, Request, Url};
/// use http_types::{Method, Request};
/// use std::collections::HashMap;
///
/// #[derive(Serialize)]
@ -658,10 +655,7 @@ impl Request {
/// }
///
/// let query = Index { page: 2, topics: vec!["rust", "crabs", "crustaceans"] };
/// let mut req = Request::new(
/// Method::Get,
/// Url::parse("https://httpbin.org/get").unwrap(),
/// );
/// let mut req = Request::get("https://httpbin.org/get");
/// req.set_query(&query).unwrap();
/// assert_eq!(req.url().query(), Some("page=2&topics[0]=rust&topics[1]=crabs&topics[2]=crustaceans"));
/// ```
@ -680,7 +674,7 @@ impl Request {
/// # Examples
///
/// ```
/// use http_types::{Method, Request, Url};
/// use http_types::{Method, Request};
///
/// let mut req = Request::get("https://example.com");
/// req.set_body("Hello, Nori!");
@ -702,7 +696,7 @@ impl Request {
/// # Examples
///
/// ```
/// use http_types::{Method, Request, Url};
/// use http_types::{Method, Request};
///
/// let mut req = Request::head("https://example.com");
/// assert_eq!(req.method(), Method::Head);
@ -723,7 +717,7 @@ impl Request {
/// # Examples
///
/// ```
/// use http_types::{Method, Request, Url};
/// use http_types::{Method, Request};
///
/// let mut req = Request::post("https://example.com");
/// assert_eq!(req.method(), Method::Post);
@ -744,7 +738,7 @@ impl Request {
/// # Examples
///
/// ```
/// use http_types::{Method, Request, Url};
/// use http_types::{Method, Request};
///
/// let mut req = Request::put("https://example.com");
/// assert_eq!(req.method(), Method::Put);
@ -764,7 +758,7 @@ impl Request {
/// # Examples
///
/// ```
/// use http_types::{Method, Request, Url};
/// use http_types::{Method, Request};
///
/// let mut req = Request::delete("https://example.com");
/// assert_eq!(req.method(), Method::Delete);
@ -785,7 +779,7 @@ impl Request {
/// # Examples
///
/// ```
/// use http_types::{Method, Request, Url};
/// use http_types::{Method, Request};
///
/// let mut req = Request::connect("https://example.com");
/// assert_eq!(req.method(), Method::Connect);
@ -806,7 +800,7 @@ impl Request {
/// # Examples
///
/// ```
/// use http_types::{Method, Request, Url};
/// use http_types::{Method, Request};
///
/// let mut req = Request::options("https://example.com");
/// assert_eq!(req.method(), Method::Options);
@ -827,7 +821,7 @@ impl Request {
/// # Examples
///
/// ```
/// use http_types::{Method, Request, Url};
/// use http_types::{Method, Request};
///
/// let mut req = Request::trace("https://example.com");
/// assert_eq!(req.method(), Method::Trace);
@ -847,7 +841,7 @@ impl Request {
/// # Examples
///
/// ```
/// use http_types::{Method, Request, Url};
/// use http_types::{Method, Request};
///
/// let mut req = Request::patch("https://example.com");
/// assert_eq!(req.method(), Method::Patch);