@@ -222,8 +222,17 @@ impl From<InvalidContentLength> for Error {
222222}
223223
224224/// The output stream for the body, implementing [`AsyncWrite`]. Call
225- /// [`Responder::start_response`] to obtain one. Once the body is complete,
226- /// it must be declared finished, using [`OutgoingBody::finish`].
225+ /// [`Responder::start_response`] or [`Client::start_request`] to obtain
226+ /// one. Once the body is complete, it must be declared finished, using
227+ /// [`Finished::finish`], [`Finished::fail`], [`Client::finish`], or
228+ /// [`Client::fail`].
229+ ///
230+ /// [`Responder::start_response`]: crate::http::server::Responder::start_response
231+ /// [`Client::start_request`]: crate::http::client::Client::start_request
232+ /// [`Finished::finish`]: crate::http::server::Finished::finish
233+ /// [`Finished::fail`]: crate::http::server::Finished::fail
234+ /// [`Client::finish`]: crate::http::client::Client::finish
235+ /// [`Client::fail`]: crate::http::client::Client::fail
227236#[ must_use]
228237pub struct OutgoingBody {
229238 // IMPORTANT: the order of these fields here matters. `stream` must
@@ -295,4 +304,8 @@ impl Drop for DontDropOutgoingBody {
295304///
296305/// To instead start the response and obtain the output stream for the body,
297306/// use [`Responder::respond`].
307+ ///
308+ /// [`Response`]: crate::http::Response
309+ /// [`Responder::start_response`]: crate::http::server::Responder::start_response
310+ /// [`Responder::respond`]: crate::http::server::Responder::respond
298311pub struct BodyForthcoming ;
0 commit comments