pub struct Body { /* private fields */ }
Expand description
A stream of Chunk
s, used when receiving bodies.
A good default Payload
to use in many applications.
Also implements futures::Stream
, so stream combinators may be used.
Implementations§
source§impl Body
impl Body
sourcepub fn empty() -> Body
pub fn empty() -> Body
Create an empty Body
stream.
Example
use hyper::{Body, Request};
// create a `GET /` request
let get = Request::new(Body::empty());
sourcepub fn channel() -> (Sender, Body)
pub fn channel() -> (Sender, Body)
Create a Body
stream with an associated sender half.
Useful when wanting to stream chunks from another thread.
sourcepub fn wrap_stream<S>(stream: S) -> Bodywhere
S: 'static + Stream + Send,
<S as Stream>::Error: Into<Box<dyn Error + Send + Sync + 'static, Global>>,
Chunk: From<<S as Stream>::Item>,
pub fn wrap_stream<S>(stream: S) -> Bodywhere
S: 'static + Stream + Send,
<S as Stream>::Error: Into<Box<dyn Error + Send + Sync + 'static, Global>>,
Chunk: From<<S as Stream>::Item>,
Wrap a futures Stream
in a box inside Body
.
Example
let chunks = vec![
"hello",
" ",
"world",
];
let stream = futures::stream::iter_ok::<_, ::std::io::Error>(chunks);
let body = Body::wrap_stream(stream);
sourcepub fn on_upgrade(self) -> OnUpgrade
pub fn on_upgrade(self) -> OnUpgrade
Converts this Body
into a Future
of a pending HTTP upgrade.
See the upgrade
module for more.
Trait Implementations§
source§impl Body for Body
impl Body for Body
source§fn poll_data(
&mut self
) -> Result<Async<Option<<Body as Body>::Data>>, <Body as Body>::Error>
fn poll_data(
&mut self
) -> Result<Async<Option<<Body as Body>::Data>>, <Body as Body>::Error>
Attempt to pull out the next data buffer of this stream.
source§fn poll_trailers(
&mut self
) -> Result<Async<Option<HeaderMap<HeaderValue>>>, <Body as Body>::Error>
fn poll_trailers(
&mut self
) -> Result<Async<Option<HeaderMap<HeaderValue>>>, <Body as Body>::Error>
Poll for an optional single
HeaderMap
of trailers. Read moresource§fn is_end_stream(&self) -> bool
fn is_end_stream(&self) -> bool
Returns
true
when the end of stream has been reached. Read moresource§impl From<Box<dyn Stream<Item = Chunk, Error = Box<dyn Error + Send + Sync + 'static, Global>> + Send + 'static, Global>> for Body
impl From<Box<dyn Stream<Item = Chunk, Error = Box<dyn Error + Send + Sync + 'static, Global>> + Send + 'static, Global>> for Body
source§impl Payload for Body
impl Payload for Body
source§fn poll_data(
&mut self
) -> Result<Async<Option<<Body as Payload>::Data>>, <Body as Payload>::Error>
fn poll_data(
&mut self
) -> Result<Async<Option<<Body as Payload>::Data>>, <Body as Payload>::Error>
Poll for a
Data
buffer. Read moresource§fn poll_trailers(
&mut self
) -> Result<Async<Option<HeaderMap<HeaderValue>>>, <Body as Payload>::Error>
fn poll_trailers(
&mut self
) -> Result<Async<Option<HeaderMap<HeaderValue>>>, <Body as Payload>::Error>
Poll for an optional single
HeaderMap
of trailers. Read moresource§fn is_end_stream(&self) -> bool
fn is_end_stream(&self) -> bool
A hint that the
Body
is complete, and doesn’t need to be polled more. Read moresource§impl Stream for Body
impl Stream for Body
source§fn poll(
&mut self
) -> Result<Async<Option<<Body as Stream>::Item>>, <Body as Stream>::Error>
fn poll(
&mut self
) -> Result<Async<Option<<Body as Stream>::Item>>, <Body as Stream>::Error>
Attempt to pull out the next value of this stream, returning
None
if
the stream is finished. Read moresource§fn wait(self) -> Wait<Self>where
Self: Sized,
fn wait(self) -> Wait<Self>where
Self: Sized,
Creates an iterator which blocks the current thread until each item of
this stream is resolved. Read more
source§fn into_future(self) -> StreamFuture<Self>where
Self: Sized,
fn into_future(self) -> StreamFuture<Self>where
Self: Sized,
Converts this stream into a
Future
. Read moresource§fn map_err<U, F>(self, f: F) -> MapErr<Self, F>where
F: FnMut(Self::Error) -> U,
Self: Sized,
fn map_err<U, F>(self, f: F) -> MapErr<Self, F>where
F: FnMut(Self::Error) -> U,
Self: Sized,
source§fn filter<F>(self, f: F) -> Filter<Self, F>where
F: FnMut(&Self::Item) -> bool,
Self: Sized,
fn filter<F>(self, f: F) -> Filter<Self, F>where
F: FnMut(&Self::Item) -> bool,
Self: Sized,
Filters the values produced by this stream according to the provided
predicate. Read more
source§fn filter_map<F, B>(self, f: F) -> FilterMap<Self, F>where
F: FnMut(Self::Item) -> Option<B>,
Self: Sized,
fn filter_map<F, B>(self, f: F) -> FilterMap<Self, F>where
F: FnMut(Self::Item) -> Option<B>,
Self: Sized,
Filters the values produced by this stream while simultaneously mapping
them to a different type. Read more
source§fn then<F, U>(self, f: F) -> Then<Self, F, U>where
F: FnMut(Result<Self::Item, Self::Error>) -> U,
U: IntoFuture,
Self: Sized,
fn then<F, U>(self, f: F) -> Then<Self, F, U>where
F: FnMut(Result<Self::Item, Self::Error>) -> U,
U: IntoFuture,
Self: Sized,
Chain on a computation for when a value is ready, passing the resulting
item to the provided closure
f
. Read moresource§fn and_then<F, U>(self, f: F) -> AndThen<Self, F, U>where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Error = Self::Error>,
Self: Sized,
fn and_then<F, U>(self, f: F) -> AndThen<Self, F, U>where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Error = Self::Error>,
Self: Sized,
Chain on a computation for when a value is ready, passing the successful
results to the provided closure
f
. Read moresource§fn or_else<F, U>(self, f: F) -> OrElse<Self, F, U>where
F: FnMut(Self::Error) -> U,
U: IntoFuture<Item = Self::Item>,
Self: Sized,
fn or_else<F, U>(self, f: F) -> OrElse<Self, F, U>where
F: FnMut(Self::Error) -> U,
U: IntoFuture<Item = Self::Item>,
Self: Sized,
Chain on a computation for when an error happens, passing the
erroneous result to the provided closure
f
. Read moresource§fn collect(self) -> Collect<Self>where
Self: Sized,
fn collect(self) -> Collect<Self>where
Self: Sized,
Collect all of the values of this stream into a vector, returning a
future representing the result of that computation. Read more
source§fn fold<F, T, Fut>(self, init: T, f: F) -> Fold<Self, F, Fut, T>where
F: FnMut(T, Self::Item) -> Fut,
Fut: IntoFuture<Item = T>,
Self::Error: From<<Fut as IntoFuture>::Error>,
Self: Sized,
fn fold<F, T, Fut>(self, init: T, f: F) -> Fold<Self, F, Fut, T>where
F: FnMut(T, Self::Item) -> Fut,
Fut: IntoFuture<Item = T>,
Self::Error: From<<Fut as IntoFuture>::Error>,
Self: Sized,
Execute an accumulating computation over a stream, collecting all the
values into one final result. Read more
source§fn skip_while<P, R>(self, pred: P) -> SkipWhile<Self, P, R>where
P: FnMut(&Self::Item) -> R,
R: IntoFuture<Item = bool, Error = Self::Error>,
Self: Sized,
fn skip_while<P, R>(self, pred: P) -> SkipWhile<Self, P, R>where
P: FnMut(&Self::Item) -> R,
R: IntoFuture<Item = bool, Error = Self::Error>,
Self: Sized,
Skip elements on this stream while the predicate provided resolves to
true
. Read moresource§fn take_while<P, R>(self, pred: P) -> TakeWhile<Self, P, R>where
P: FnMut(&Self::Item) -> R,
R: IntoFuture<Item = bool, Error = Self::Error>,
Self: Sized,
fn take_while<P, R>(self, pred: P) -> TakeWhile<Self, P, R>where
P: FnMut(&Self::Item) -> R,
R: IntoFuture<Item = bool, Error = Self::Error>,
Self: Sized,
Take elements from this stream while the predicate provided resolves to
true
. Read moresource§fn for_each<F, U>(self, f: F) -> ForEach<Self, F, U>where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Item = (), Error = Self::Error>,
Self: Sized,
fn for_each<F, U>(self, f: F) -> ForEach<Self, F, U>where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Item = (), Error = Self::Error>,
Self: Sized,
Runs this stream to completion, executing the provided closure for each
element on the stream. Read more
source§fn from_err<E>(self) -> FromErr<Self, E>where
E: From<Self::Error>,
Self: Sized,
fn from_err<E>(self) -> FromErr<Self, E>where
E: From<Self::Error>,
Self: Sized,
Map this stream’s error to any error implementing
From
for
this stream’s Error
, returning a new stream. Read moresource§fn take(self, amt: u64) -> Take<Self>where
Self: Sized,
fn take(self, amt: u64) -> Take<Self>where
Self: Sized,
Creates a new stream of at most
amt
items of the underlying stream. Read moresource§fn skip(self, amt: u64) -> Skip<Self>where
Self: Sized,
fn skip(self, amt: u64) -> Skip<Self>where
Self: Sized,
Creates a new stream which skips
amt
items of the underlying stream. Read moresource§fn fuse(self) -> Fuse<Self>where
Self: Sized,
fn fuse(self) -> Fuse<Self>where
Self: Sized,
Fuse a stream such that
poll
will never again be called once it has
finished. Read moresource§fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
Borrows a stream, rather than consuming it. Read more
source§fn merge<S>(self, other: S) -> Merge<Self, S>where
S: Stream<Error = Self::Error>,
Self: Sized,
fn merge<S>(self, other: S) -> Merge<Self, S>where
S: Stream<Error = Self::Error>,
Self: Sized,
👎Deprecated: functionality provided by
select
nowAn adapter for merging the output of two streams. Read more
source§fn zip<S>(self, other: S) -> Zip<Self, S>where
S: Stream<Error = Self::Error>,
Self: Sized,
fn zip<S>(self, other: S) -> Zip<Self, S>where
S: Stream<Error = Self::Error>,
Self: Sized,
An adapter for zipping two streams together. Read more
source§fn chain<S>(self, other: S) -> Chain<Self, S>where
S: Stream<Item = Self::Item, Error = Self::Error>,
Self: Sized,
fn chain<S>(self, other: S) -> Chain<Self, S>where
S: Stream<Item = Self::Item, Error = Self::Error>,
Self: Sized,
Adapter for chaining two stream. Read more
source§fn peekable(self) -> Peekable<Self>where
Self: Sized,
fn peekable(self) -> Peekable<Self>where
Self: Sized,
Creates a new stream which exposes a
peek
method. Read moresource§fn chunks(self, capacity: usize) -> Chunks<Self>where
Self: Sized,
fn chunks(self, capacity: usize) -> Chunks<Self>where
Self: Sized,
An adaptor for chunking up items of the stream inside a vector. Read more
source§fn select<S>(self, other: S) -> Select<Self, S>where
S: Stream<Item = Self::Item, Error = Self::Error>,
Self: Sized,
fn select<S>(self, other: S) -> Select<Self, S>where
S: Stream<Item = Self::Item, Error = Self::Error>,
Self: Sized,
Creates a stream that selects the next element from either this stream
or the provided one, whichever is ready first. Read more
source§fn forward<S>(self, sink: S) -> Forward<Self, S>where
S: Sink<SinkItem = Self::Item>,
Self::Error: From<<S as Sink>::SinkError>,
Self: Sized,
fn forward<S>(self, sink: S) -> Forward<Self, S>where
S: Sink<SinkItem = Self::Item>,
Self::Error: From<<S as Sink>::SinkError>,
Self: Sized,
A future that completes after the given stream has been fully processed
into the sink, including flushing. Read more
source§fn inspect<F>(self, f: F) -> Inspect<Self, F>where
F: FnMut(&Self::Item),
Self: Sized,
fn inspect<F>(self, f: F) -> Inspect<Self, F>where
F: FnMut(&Self::Item),
Self: Sized,
Do something with each item of this stream, afterwards passing it on. Read more
source§fn inspect_err<F>(self, f: F) -> InspectErr<Self, F>where
F: FnMut(&Self::Error),
Self: Sized,
fn inspect_err<F>(self, f: F) -> InspectErr<Self, F>where
F: FnMut(&Self::Error),
Self: Sized,
Do something with the error of this stream, afterwards passing it on. Read more
Auto Trait Implementations§
impl !RefUnwindSafe for Body
impl Send for Body
impl !Sync for Body
impl Unpin for Body
impl !UnwindSafe for Body
Blanket Implementations§
source§impl<T> StreamExt for Twhere
T: Stream + ?Sized,
impl<T> StreamExt for Twhere
T: Stream + ?Sized,
source§fn throttle(self, duration: Duration) -> Throttle<Self>where
Self: Sized,
fn throttle(self, duration: Duration) -> Throttle<Self>where
Self: Sized,
Throttle down the stream by enforcing a fixed delay between items. Read more