forked/reqwest-impersonate
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

improve docs around Body type

Browse Source
This commit is contained in:
Sean McArthur
2017-07-13 12:17:06 -07:00
parent 12ee6fbcde
commit fb4dd2e0b3
2 changed files with 18 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/body.rs
View File

@@ -7,7 +7,13 @@ use hyper::{self, Chunk};
use {async_impl, wait}; use {async_impl, wait};
/// Body type for a request. /// The body of a `Request`.
///
/// In most cases, this is not needed directly, as the
/// [`RequestBuilder.body`][builder] method uses `Into<Body>`, which allows
/// passing many things (like a string or vector of bytes).
///
/// [builder]: ./struct.RequestBuilder.html#method.body
#[derive(Debug)] #[derive(Debug)]
pub struct Body { pub struct Body {
reader: Kind, reader: Kind,
@@ -52,10 +58,9 @@ impl Body {
} }
} }
/// Create a `Body` from a `Reader` where we can predict the size in /// Create a `Body` from a `Read` where the size is known in advance
/// advance, but where we don't want to load the data in memory. This /// advance, but the data should not be loaded in full to memory. This will
/// is useful if we need to ensure `Content-Length` is passed with the /// set the `Content-Length` header, and stream from the `Read`.
/// request.
/// ///
/// ```rust /// ```rust
/// # use std::fs::File; /// # use std::fs::File;

8
src/request.rs
View File

@@ -156,6 +156,10 @@ impl RequestBuilder {
/// Set the request body. /// Set the request body.
/// ///
/// # Examples
///
/// Using a string:
///
/// ```rust /// ```rust
/// # fn run() -> Result<(), Box<::std::error::Error>> { /// # fn run() -> Result<(), Box<::std::error::Error>> {
/// let client = reqwest::Client::new()?; /// let client = reqwest::Client::new()?;
@@ -166,6 +170,8 @@ impl RequestBuilder {
/// # } /// # }
/// ``` /// ```
/// ///
/// Using a `File`:
///
/// ```rust /// ```rust
/// # use std::fs; /// # use std::fs;
/// # fn run() -> Result<(), Box<::std::error::Error>> { /// # fn run() -> Result<(), Box<::std::error::Error>> {
@@ -178,6 +184,8 @@ impl RequestBuilder {
/// # } /// # }
/// ``` /// ```
/// ///
/// Using arbitrary bytes:
///
/// ```rust /// ```rust
/// # use std::fs; /// # use std::fs;
/// # fn run() -> Result<(), Box<::std::error::Error>> { /// # fn run() -> Result<(), Box<::std::error::Error>> {