more doc
This commit is contained in:
22
src/lib.rs
22
src/lib.rs
@@ -22,6 +22,28 @@
|
||||
//! To maintain a state, cookies, between requests, you use an [agent](struct.Agent.html).
|
||||
//! Agents also follow the build pattern. Agents are created with `ureq::agent().build()`.
|
||||
//!
|
||||
//! # Content-Length
|
||||
//!
|
||||
//! The library will set the content length on the request when using
|
||||
//! [`.send_str()`](struct.Request.html#method.send_str) or
|
||||
//! [`.send_json()`](struct.Request.html#method.send_json). In other cases the user
|
||||
//! can optionally `request.set("Content-Length", 1234)`.
|
||||
//!
|
||||
//! For responses, if the `Content-Length` header is present, the methods that reads the
|
||||
//! body (as string, json or read trait) are all limited to the length specified in the header.
|
||||
//!
|
||||
//! # Transfer-Encoding: chunked
|
||||
//!
|
||||
//! Dechunking is a response body is done automatically if the response headers contains
|
||||
//! a `Transfer-Encoding` header.
|
||||
//!
|
||||
//! Sending a chunked request body is done by setting the header prior to sending a body.
|
||||
//!
|
||||
//! ```
|
||||
//! let resp = ureq::post("http://my-server.com/ingest")
|
||||
//! .set("Transfer-Encoding", "chunked")`
|
||||
//! .send("Hello world");
|
||||
//! ```
|
||||
|
||||
extern crate ascii;
|
||||
extern crate base64;
|
||||
|
||||
@@ -171,6 +171,8 @@ impl Request {
|
||||
|
||||
/// Send data as a string.
|
||||
///
|
||||
/// The `Content-Length` header is implicitly set to the length of the serialized value.
|
||||
///
|
||||
/// ```
|
||||
/// let r = ureq::post("/my_page")
|
||||
/// .content_type("text/plain")
|
||||
@@ -187,6 +189,7 @@ impl Request {
|
||||
|
||||
/// Send data from a reader.
|
||||
///
|
||||
/// The `Content-Length` header is not set because we can't know the length of the reader.
|
||||
///
|
||||
///
|
||||
pub fn send<R>(&mut self, reader: R) -> Response
|
||||
|
||||
Reference in New Issue
Block a user