Skip to content

Commit e3801d0

Browse files
yoshuawuytsyoshuawuyts
authored
Merge pull request #324 from http-rs/simplify-request-examples
Simplify Request examples
2 parents c432783 + 667ecba commit e3801d0

File tree

2 files changed

+46
-52
lines changed

2 files changed

+46
-52
lines changed

‎src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
//! ```
99
//! # fn main() -> Result<(), http_types::url::ParseError> {
1010
//! #
11-
//! use http_types::{Url, Method, Request, Response, StatusCode};
11+
//! use http_types::{Method, Request, Response, StatusCode};
1212
//!
13-
//! let mut req = Request::new(Method::Get, Url::parse("https://example.com")?);
13+
//! let mut req = Request::new(Method::Get, "https://example.com");
1414
//! req.set_body("Hello, Nori!");
1515
//!
1616
//! let mut res = Response::new(StatusCode::Ok);

‎src/request.rs

Lines changed: 44 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ pin_project_lite::pin_project! {
2121
/// # Examples
2222
///
2323
/// ```
24-
/// use http_types::{Url, Method, Request};
24+
/// use http_types::Request;
2525
///
26-
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com").unwrap());
26+
/// let mut req = Request::get("https://example.com");
2727
/// req.set_body("Hello, Nori!");
2828
/// ```
2929
#[derive(Debug)]
@@ -157,8 +157,8 @@ impl Request {
157157
/// ```
158158
/// # fn main() -> Result<(), http_types::Error> {
159159
/// #
160-
/// use http_types::{Method, Request, Response, StatusCode, Url};
161-
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?);
160+
/// use http_types::{Request, Response, StatusCode};
161+
/// let mut req = Request::get("https://example.com");
162162
/// assert_eq!(req.url().scheme(), "https");
163163
/// #
164164
/// # Ok(()) }
@@ -175,7 +175,7 @@ impl Request {
175175
/// # fn main() -> Result<(), http_types::Error> {
176176
/// #
177177
/// use http_types::{Method, Request, Response, StatusCode, Url};
178-
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?);
178+
/// let mut req = Request::get("https://example.com");
179179
/// req.url_mut().set_scheme("http");
180180
/// assert_eq!(req.url().scheme(), "http");
181181
/// #
@@ -190,9 +190,9 @@ impl Request {
190190
/// # Examples
191191
///
192192
/// ```
193-
/// use http_types::{Method, Request, Url};
193+
/// use http_types::{Method, Request};
194194
///
195-
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com").unwrap());
195+
/// let mut req = Request::get("https://example.com");
196196
/// req.set_body("Hello, Nori!");
197197
/// ```
198198
pub fn set_body(&mut self, body: impl Into<Body>) {
@@ -208,9 +208,9 @@ impl Request {
208208
/// # use async_std::io::prelude::*;
209209
/// # fn main() -> http_types::Result<()> { async_std::task::block_on(async {
210210
/// #
211-
/// use http_types::{Body, Method, Request, Url};
211+
/// use http_types::{Body, Method, Request};
212212
///
213-
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com").unwrap());
213+
/// let mut req = Request::get("https://example.com");
214214
/// req.set_body("Hello, Nori!");
215215
/// let mut body: Body = req.replace_body("Hello, Chashu!");
216216
///
@@ -234,9 +234,9 @@ impl Request {
234234
/// # use async_std::io::prelude::*;
235235
/// # fn main() -> http_types::Result<()> { async_std::task::block_on(async {
236236
/// #
237-
/// use http_types::{Body, Method, Request, Url};
237+
/// use http_types::{Body, Request};
238238
///
239-
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com").unwrap());
239+
/// let mut req = Request::get("https://example.com");
240240
/// req.set_body("Hello, Nori!");
241241
/// let mut body = "Hello, Chashu!".into();
242242
/// req.swap_body(&mut body);
@@ -260,9 +260,9 @@ impl Request {
260260
/// # use async_std::io::prelude::*;
261261
/// # fn main() -> http_types::Result<()> { async_std::task::block_on(async {
262262
/// #
263-
/// use http_types::{Body, Method, Request, Url};
263+
/// use http_types::{Body, Request};
264264
///
265-
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com").unwrap());
265+
/// let mut req = Request::get("https://example.com");
266266
/// req.set_body("Hello, Nori!");
267267
/// let mut body: Body = req.take_body();
268268
///
@@ -293,9 +293,9 @@ impl Request {
293293
/// # use std::io::prelude::*;
294294
/// # fn main() -> http_types::Result<()> { async_std::task::block_on(async {
295295
/// use async_std::io::Cursor;
296-
/// use http_types::{Body, Method, Request, Url};
296+
/// use http_types::{Body, Request};
297297
///
298-
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com").unwrap());
298+
/// let mut req = Request::get("https://example.com");
299299
///
300300
/// let cursor = Cursor::new("Hello Nori");
301301
/// let body = Body::from_reader(cursor, None);
@@ -319,10 +319,10 @@ impl Request {
319319
///
320320
/// ```
321321
/// # fn main() -> http_types::Result<()> { async_std::task::block_on(async {
322-
/// use http_types::{Body, Method, Request, Url};
322+
/// use http_types::{Body, Request};
323323
///
324324
/// let bytes = vec![1, 2, 3];
325-
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com").unwrap());
325+
/// let mut req = Request::get("https://example.com");
326326
/// req.set_body(Body::from_bytes(bytes));
327327
///
328328
/// let bytes = req.body_bytes().await?;
@@ -346,7 +346,7 @@ impl Request {
346346
/// ```
347347
/// # fn main() -> http_types::Result<()> { async_std::task::block_on(async {
348348
/// use http_types::convert::{Deserialize, Serialize};
349-
/// use http_types::{Body, Method, Request, Url};
349+
/// use http_types::{Body, Request};
350350
///
351351
/// #[derive(Debug, Serialize, Deserialize)]
352352
/// struct Cat {
@@ -356,7 +356,7 @@ impl Request {
356356
/// let cat = Cat {
357357
/// name: String::from("chashu"),
358358
/// };
359-
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com").unwrap());
359+
/// let mut req = Request::get("https://example.com");
360360
/// req.set_body(Body::from_json(&cat)?);
361361
///
362362
/// let cat: Cat = req.body_json().await?;
@@ -380,7 +380,7 @@ impl Request {
380380
/// ```
381381
/// # fn main() -> http_types::Result<()> { async_std::task::block_on(async {
382382
/// use http_types::convert::{Deserialize, Serialize};
383-
/// use http_types::{Body, Method, Request, Url};
383+
/// use http_types::{Body, Request};
384384
///
385385
/// #[derive(Debug, Serialize, Deserialize)]
386386
/// struct Cat {
@@ -390,7 +390,7 @@ impl Request {
390390
/// let cat = Cat {
391391
/// name: String::from("chashu"),
392392
/// };
393-
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com").unwrap());
393+
/// let mut req = Request::get("https://example.com");
394394
/// req.set_body(Body::from_form(&cat)?);
395395
///
396396
/// let cat: Cat = req.body_form().await?;
@@ -424,9 +424,9 @@ impl Request {
424424
/// ```
425425
/// # fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
426426
/// #
427-
/// use http_types::{Method, Request, Url};
427+
/// use http_types::Request;
428428
///
429-
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?);
429+
/// let mut req = Request::get("https://example.com");
430430
/// req.insert_header("Content-Type", "text/plain");
431431
/// #
432432
/// # Ok(()) }
@@ -450,9 +450,9 @@ impl Request {
450450
/// ```
451451
/// # fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
452452
/// #
453-
/// use http_types::{Method, Request, Url};
453+
/// use http_types::Request;
454454
///
455-
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?);
455+
/// let mut req = Request::get("https://example.com");
456456
/// req.append_header("Content-Type", "text/plain");
457457
/// #
458458
/// # Ok(()) }
@@ -503,11 +503,11 @@ impl Request {
503503
/// # Examples
504504
///
505505
/// ```
506-
/// use http_types::{Method, Request, Url, Version};
506+
/// use http_types::{Request, Version};
507507
///
508508
/// # fn main() -> Result<(), http_types::Error> {
509509
/// #
510-
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?);
510+
/// let mut req = Request::get("https://example.com");
511511
/// assert_eq!(req.version(), None);
512512
///
513513
/// req.set_version(Some(Version::Http2_0));
@@ -524,11 +524,11 @@ impl Request {
524524
/// # Examples
525525
///
526526
/// ```
527-
/// use http_types::{Method, Request, Url, Version};
527+
/// use http_types::{Request, Version};
528528
///
529529
/// # fn main() -> Result<(), http_types::Error> {
530530
/// #
531-
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?);
531+
/// let mut req = Request::get("https://example.com");
532532
/// req.set_version(Some(Version::Http2_0));
533533
/// #
534534
/// # Ok(()) }
@@ -594,9 +594,9 @@ impl Request {
594594
/// ```
595595
/// # fn main() -> Result<(), http_types::Error> {
596596
/// #
597-
/// use http_types::{Method, Request, Url, Version};
597+
/// use http_types::{Request, Version};
598598
///
599-
/// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?);
599+
/// let mut req = Request::get("https://example.com");
600600
/// req.ext_mut().insert("hello from the extension");
601601
/// assert_eq!(req.ext().get(), Some(&"hello from the extension"));
602602
/// #
@@ -612,7 +612,7 @@ impl Request {
612612
///
613613
/// ```
614614
/// use http_types::convert::Deserialize;
615-
/// use http_types::{Method, Request, Url};
615+
/// use http_types::Request;
616616
/// use std::collections::HashMap;
617617
///
618618
/// #[derive(Deserialize)]
@@ -621,10 +621,7 @@ impl Request {
621621
/// selections: HashMap<String, String>,
622622
/// }
623623
///
624-
/// let req = Request::new(
625-
/// Method::Get,
626-
/// Url::parse("https://httpbin.org/get?page=2&selections[width]=narrow&selections[height]=tall").unwrap(),
627-
/// );
624+
/// let mut req = Request::get("https://httpbin.org/get?page=2&selections[width]=narrow&selections[height]=tall");
628625
/// let Index { page, selections } = req.query().unwrap();
629626
/// assert_eq!(page, 2);
630627
/// assert_eq!(selections["width"], "narrow");
@@ -648,7 +645,7 @@ impl Request {
648645
///
649646
/// ```
650647
/// use http_types::convert::Serialize;
651-
/// use http_types::{Method, Request, Url};
648+
/// use http_types::{Method, Request};
652649
/// use std::collections::HashMap;
653650
///
654651
/// #[derive(Serialize)]
@@ -658,10 +655,7 @@ impl Request {
658655
/// }
659656
///
660657
/// let query = Index { page: 2, topics: vec!["rust", "crabs", "crustaceans"] };
661-
/// let mut req = Request::new(
662-
/// Method::Get,
663-
/// Url::parse("https://httpbin.org/get").unwrap(),
664-
/// );
658+
/// let mut req = Request::get("https://httpbin.org/get");
665659
/// req.set_query(&query).unwrap();
666660
/// assert_eq!(req.url().query(), Some("page=2&topics[0]=rust&topics[1]=crabs&topics[2]=crustaceans"));
667661
/// ```
@@ -680,7 +674,7 @@ impl Request {
680674
/// # Examples
681675
///
682676
/// ```
683-
/// use http_types::{Method, Request, Url};
677+
/// use http_types::{Method, Request};
684678
///
685679
/// let mut req = Request::get("https://example.com");
686680
/// req.set_body("Hello, Nori!");
@@ -702,7 +696,7 @@ impl Request {
702696
/// # Examples
703697
///
704698
/// ```
705-
/// use http_types::{Method, Request, Url};
699+
/// use http_types::{Method, Request};
706700
///
707701
/// let mut req = Request::head("https://example.com");
708702
/// assert_eq!(req.method(), Method::Head);
@@ -723,7 +717,7 @@ impl Request {
723717
/// # Examples
724718
///
725719
/// ```
726-
/// use http_types::{Method, Request, Url};
720+
/// use http_types::{Method, Request};
727721
///
728722
/// let mut req = Request::post("https://example.com");
729723
/// assert_eq!(req.method(), Method::Post);
@@ -744,7 +738,7 @@ impl Request {
744738
/// # Examples
745739
///
746740
/// ```
747-
/// use http_types::{Method, Request, Url};
741+
/// use http_types::{Method, Request};
748742
///
749743
/// let mut req = Request::put("https://example.com");
750744
/// assert_eq!(req.method(), Method::Put);
@@ -764,7 +758,7 @@ impl Request {
764758
/// # Examples
765759
///
766760
/// ```
767-
/// use http_types::{Method, Request, Url};
761+
/// use http_types::{Method, Request};
768762
///
769763
/// let mut req = Request::delete("https://example.com");
770764
/// assert_eq!(req.method(), Method::Delete);
@@ -785,7 +779,7 @@ impl Request {
785779
/// # Examples
786780
///
787781
/// ```
788-
/// use http_types::{Method, Request, Url};
782+
/// use http_types::{Method, Request};
789783
///
790784
/// let mut req = Request::connect("https://example.com");
791785
/// assert_eq!(req.method(), Method::Connect);
@@ -806,7 +800,7 @@ impl Request {
806800
/// # Examples
807801
///
808802
/// ```
809-
/// use http_types::{Method, Request, Url};
803+
/// use http_types::{Method, Request};
810804
///
811805
/// let mut req = Request::options("https://example.com");
812806
/// assert_eq!(req.method(), Method::Options);
@@ -827,7 +821,7 @@ impl Request {
827821
/// # Examples
828822
///
829823
/// ```
830-
/// use http_types::{Method, Request, Url};
824+
/// use http_types::{Method, Request};
831825
///
832826
/// let mut req = Request::trace("https://example.com");
833827
/// assert_eq!(req.method(), Method::Trace);
@@ -847,7 +841,7 @@ impl Request {
847841
/// # Examples
848842
///
849843
/// ```
850-
/// use http_types::{Method, Request, Url};
844+
/// use http_types::{Method, Request};
851845
///
852846
/// let mut req = Request::patch("https://example.com");
853847
/// assert_eq!(req.method(), Method::Patch);

0 commit comments

Comments
 (0)