Struct chrootable_https::Body [−][src]
#[must_use = "streams do nothing unless polled"]pub struct Body { /* fields omitted */ }
A stream of Chunks, used when receiving bodies.
A good default Payload to use in many applications.
Also implements futures::Stream, so stream combinators may be used.
Methods
impl Body[src]
impl Bodypub fn empty() -> Body[src]
pub fn empty() -> BodyCreate an empty Body stream.
Example
use hyper::{Body, Request}; // create a `GET /` request let get = Request::new(Body::empty());
pub fn channel() -> (Sender, Body)[src]
pub fn channel() -> (Sender, Body)Create a Body stream with an associated sender half.
Useful when wanting to stream chunks from another thread.
pub fn wrap_stream<S>(stream: S) -> Body where
S: Stream + Send + 'static,
<S as Stream>::Error: Into<Box<Error + 'static + Send + Sync>>,
Chunk: From<<S as Stream>::Item>, [src]
pub fn wrap_stream<S>(stream: S) -> Body where
S: Stream + Send + 'static,
<S as Stream>::Error: Into<Box<Error + 'static + Send + Sync>>,
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);
pub fn on_upgrade(self) -> OnUpgrade[src]
pub fn on_upgrade(self) -> OnUpgradeConverts this Body into a Future of a pending HTTP upgrade.
See the upgrade module for more.
Trait Implementations
impl Debug for Body[src]
impl Debug for Bodyfn fmt(&self, f: &mut Formatter) -> Result<(), Error>[src]
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>Formats the value using the given formatter. Read more
impl From<Cow<'static, str>> for Body[src]
impl From<Cow<'static, str>> for Bodyimpl From<Box<Stream<Error = Box<Error + 'static + Send + Sync>, Item = Chunk> + 'static + Send>> for Body[src]
impl From<Box<Stream<Error = Box<Error + 'static + Send + Sync>, Item = Chunk> + 'static + Send>> for Bodyfn from(
stream: Box<Stream<Error = Box<Error + 'static + Send + Sync>, Item = Chunk> + 'static + Send>
) -> Body[src]
fn from(
stream: Box<Stream<Error = Box<Error + 'static + Send + Sync>, Item = Chunk> + 'static + Send>
) -> BodyPerforms the conversion.
impl From<&'static [u8]> for Body[src]
impl From<&'static [u8]> for Bodyimpl From<String> for Body[src]
impl From<String> for Bodyimpl From<Chunk> for Body[src]
impl From<Chunk> for Bodyimpl From<&'static str> for Body[src]
impl From<&'static str> for Bodyimpl From<Vec<u8>> for Body[src]
impl From<Vec<u8>> for Bodyimpl From<Bytes> for Body[src]
impl From<Bytes> for Bodyimpl From<Cow<'static, [u8]>> for Body[src]
impl From<Cow<'static, [u8]>> for Bodyimpl Payload for Body[src]
impl Payload for Bodytype Data = Chunk
A buffer of bytes representing a single chunk of a body.
type Error = Error
The error type of this stream.
fn poll_data(
&mut self
) -> Result<Async<Option<<Body as Payload>::Data>>, <Body as Payload>::Error>[src]
fn poll_data(
&mut self
) -> Result<Async<Option<<Body as Payload>::Data>>, <Body as Payload>::Error>Poll for a Data buffer. Read more
fn poll_trailers(
&mut self
) -> Result<Async<Option<HeaderMap<HeaderValue>>>, <Body as Payload>::Error>[src]
fn poll_trailers(
&mut self
) -> Result<Async<Option<HeaderMap<HeaderValue>>>, <Body as Payload>::Error>Poll for an optional single HeaderMap of trailers. Read more
fn is_end_stream(&self) -> bool[src]
fn is_end_stream(&self) -> boolA hint that the Body is complete, and doesn't need to be polled more. Read more
fn content_length(&self) -> Option<u64>[src]
fn content_length(&self) -> Option<u64>Return a length of the total bytes that will be streamed, if known. Read more
impl Default for Body[src]
impl Default for Bodyfn default() -> Body[src]
fn default() -> BodyReturns Body::empty().
impl Stream for Body[src]
impl Stream for Bodytype Item = Chunk
The type of item this stream will yield on success.
type Error = Error
The type of error this stream may generate.
fn poll(
&mut self
) -> Result<Async<Option<<Body as Stream>::Item>>, <Body as Stream>::Error>[src]
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 more
ⓘImportant traits for Wait<S>fn wait(self) -> Wait<Self>[src]
fn wait(self) -> Wait<Self>Creates an iterator which blocks the current thread until each item of this stream is resolved. Read more
fn into_future(self) -> StreamFuture<Self>[src]
fn into_future(self) -> StreamFuture<Self>Converts this stream into a Future. Read more
fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> U, [src]
fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> U, Converts a stream of type T to a stream of type U. Read more
fn map_err<U, F>(self, f: F) -> MapErr<Self, F> where
F: FnMut(Self::Error) -> U, [src]
fn map_err<U, F>(self, f: F) -> MapErr<Self, F> where
F: FnMut(Self::Error) -> U, Converts a stream of error type T to a stream of error type U. Read more
fn filter<F>(self, f: F) -> Filter<Self, F> where
F: FnMut(&Self::Item) -> bool, [src]
fn filter<F>(self, f: F) -> Filter<Self, F> where
F: FnMut(&Self::Item) -> bool, Filters the values produced by this stream according to the provided predicate. Read more
fn filter_map<F, B>(self, f: F) -> FilterMap<Self, F> where
F: FnMut(Self::Item) -> Option<B>, [src]
fn filter_map<F, B>(self, f: F) -> FilterMap<Self, F> where
F: FnMut(Self::Item) -> Option<B>, Filters the values produced by this stream while simultaneously mapping them to a different type. Read more
fn then<F, U>(self, f: F) -> Then<Self, F, U> where
F: FnMut(Result<Self::Item, Self::Error>) -> U,
U: IntoFuture, [src]
fn then<F, U>(self, f: F) -> Then<Self, F, U> where
F: FnMut(Result<Self::Item, Self::Error>) -> U,
U: IntoFuture, Chain on a computation for when a value is ready, passing the resulting item to the provided closure f. Read more
fn and_then<F, U>(self, f: F) -> AndThen<Self, F, U> where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Error = Self::Error>, [src]
fn and_then<F, U>(self, f: F) -> AndThen<Self, F, U> where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Error = Self::Error>, Chain on a computation for when a value is ready, passing the successful results to the provided closure f. Read more
fn or_else<F, U>(self, f: F) -> OrElse<Self, F, U> where
F: FnMut(Self::Error) -> U,
U: IntoFuture<Item = Self::Item>, [src]
fn or_else<F, U>(self, f: F) -> OrElse<Self, F, U> where
F: FnMut(Self::Error) -> U,
U: IntoFuture<Item = Self::Item>, Chain on a computation for when an error happens, passing the erroneous result to the provided closure f. Read more
fn collect(self) -> Collect<Self>[src]
fn collect(self) -> Collect<Self>Collect all of the values of this stream into a vector, returning a future representing the result of that computation. Read more
fn concat2(self) -> Concat2<Self> where
Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
Self::Item: IntoIterator,
Self::Item: Default, [src]
fn concat2(self) -> Concat2<Self> where
Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
Self::Item: IntoIterator,
Self::Item: Default, Concatenate all results of a stream into a single extendable destination, returning a future representing the end result. Read more
fn concat(self) -> Concat<Self> where
Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
Self::Item: IntoIterator, [src]
fn concat(self) -> Concat<Self> where
Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
Self::Item: IntoIterator, : please use Stream::concat2 instead
Concatenate all results of a stream into a single extendable destination, returning a future representing the end result. Read more
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>, [src]
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>, Execute an accumulating computation over a stream, collecting all the values into one final result. Read more
fn flatten(self) -> Flatten<Self> where
Self::Item: Stream,
<Self::Item as Stream>::Error: From<Self::Error>, [src]
fn flatten(self) -> Flatten<Self> where
Self::Item: Stream,
<Self::Item as Stream>::Error: From<Self::Error>, Flattens a stream of streams into just one continuous stream. Read more
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>, [src]
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>, Skip elements on this stream while the predicate provided resolves to true. Read more
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>, [src]
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>, Take elements from this stream while the predicate provided resolves to true. Read more
fn for_each<F, U>(self, f: F) -> ForEach<Self, F, U> where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Item = (), Error = Self::Error>, [src]
fn for_each<F, U>(self, f: F) -> ForEach<Self, F, U> where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Item = (), Error = Self::Error>, Runs this stream to completion, executing the provided closure for each element on the stream. Read more
fn from_err<E>(self) -> FromErr<Self, E> where
E: From<Self::Error>, [src]
fn from_err<E>(self) -> FromErr<Self, E> where
E: From<Self::Error>, Map this stream's error to any error implementing From for this stream's Error, returning a new stream. Read more
fn take(self, amt: u64) -> Take<Self>[src]
fn take(self, amt: u64) -> Take<Self>Creates a new stream of at most amt items of the underlying stream. Read more
fn skip(self, amt: u64) -> Skip<Self>[src]
fn skip(self, amt: u64) -> Skip<Self>Creates a new stream which skips amt items of the underlying stream. Read more
fn fuse(self) -> Fuse<Self>[src]
fn fuse(self) -> Fuse<Self>Fuse a stream such that poll will never again be called once it has finished. Read more
ⓘImportant traits for &'a mut Rfn by_ref(&mut self) -> &mut Self[src]
fn by_ref(&mut self) -> &mut SelfBorrows a stream, rather than consuming it. Read more
fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe, [src]
fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe, Catches unwinding panics while polling the stream. Read more
fn buffered(self, amt: usize) -> Buffered<Self> where
Self::Item: IntoFuture,
<Self::Item as IntoFuture>::Error == Self::Error, [src]
fn buffered(self, amt: usize) -> Buffered<Self> where
Self::Item: IntoFuture,
<Self::Item as IntoFuture>::Error == Self::Error, An adaptor for creating a buffered list of pending futures. Read more
fn buffer_unordered(self, amt: usize) -> BufferUnordered<Self> where
Self::Item: IntoFuture,
<Self::Item as IntoFuture>::Error == Self::Error, [src]
fn buffer_unordered(self, amt: usize) -> BufferUnordered<Self> where
Self::Item: IntoFuture,
<Self::Item as IntoFuture>::Error == Self::Error, An adaptor for creating a buffered list of pending futures (unordered). Read more
fn merge<S>(self, other: S) -> Merge<Self, S> where
S: Stream<Error = Self::Error>, [src]
fn merge<S>(self, other: S) -> Merge<Self, S> where
S: Stream<Error = Self::Error>, : functionality provided by select now
An adapter for merging the output of two streams. Read more
fn zip<S>(self, other: S) -> Zip<Self, S> where
S: Stream<Error = Self::Error>, [src]
fn zip<S>(self, other: S) -> Zip<Self, S> where
S: Stream<Error = Self::Error>, An adapter for zipping two streams together. Read more
fn chain<S>(self, other: S) -> Chain<Self, S> where
S: Stream<Item = Self::Item, Error = Self::Error>, [src]
fn chain<S>(self, other: S) -> Chain<Self, S> where
S: Stream<Item = Self::Item, Error = Self::Error>, Adapter for chaining two stream. Read more
fn peekable(self) -> Peekable<Self>[src]
fn peekable(self) -> Peekable<Self>Creates a new stream which exposes a peek method. Read more
fn chunks(self, capacity: usize) -> Chunks<Self>[src]
fn chunks(self, capacity: usize) -> Chunks<Self>An adaptor for chunking up items of the stream inside a vector. Read more
fn select<S>(self, other: S) -> Select<Self, S> where
S: Stream<Item = Self::Item, Error = Self::Error>, [src]
fn select<S>(self, other: S) -> Select<Self, S> where
S: Stream<Item = Self::Item, Error = Self::Error>, Creates a stream that selects the next element from either this stream or the provided one, whichever is ready first. Read more
fn forward<S>(self, sink: S) -> Forward<Self, S> where
S: Sink<SinkItem = Self::Item>,
Self::Error: From<<S as Sink>::SinkError>, [src]
fn forward<S>(self, sink: S) -> Forward<Self, S> where
S: Sink<SinkItem = Self::Item>,
Self::Error: From<<S as Sink>::SinkError>, A future that completes after the given stream has been fully processed into the sink, including flushing. Read more
fn split(self) -> (SplitSink<Self>, SplitStream<Self>) where
Self: Sink, [src]
fn split(self) -> (SplitSink<Self>, SplitStream<Self>) where
Self: Sink, Splits this Stream + Sink object into separate Stream and Sink objects. Read more
fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnMut(&Self::Item), [src]
fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnMut(&Self::Item), Do something with each item of this stream, afterwards passing it on. Read more
fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
F: FnMut(&Self::Error), [src]
fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
F: FnMut(&Self::Error), Do something with the error of this stream, afterwards passing it on. Read more