Struct saphir::Body

pub struct Body { /* private fields */ }

Expand description

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.

Implementations

impl 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());

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) -> Bodywhere
    S: 'static + Stream + Send,
    <S as Stream>::Error: Into<Box<dyn Error + Sync + Send + '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);

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

impl Body for Body

type Data = Chunk

Values yielded by the Body.

type Error = Error

The error type this BufStream might generate.

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.

fn poll_trailers(
&mut self
) -> Result<Async<Option<HeaderMap<HeaderValue>>>, <Body as Body>::Error>

Poll for an optional single HeaderMap of trailers. Read more

fn is_end_stream(&self) -> bool

Returns true when the end of stream has been reached. Read more

fn size_hint(&self) -> SizeHint

Returns the bounds on the remaining length of the stream. Read more

impl Debug for Body

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more

impl Default for Body

fn default() -> Body

Returns Body::empty().

impl From<&'static [u8]> for Body

fn from(slice: &'static [u8]) -> Body

Converts to this type from the input type.

impl From<&'static str> for Body

fn from(slice: &'static str) -> Body

Converts to this type from the input type.

impl From<Box<dyn Stream<Item = Chunk, Error = Box<dyn Error + Sync + Send + 'static, Global>> + Send + 'static, Global>> for Body

fn from(
stream: Box<dyn Stream<Item = Chunk, Error = Box<dyn Error + Sync + Send + 'static, Global>> + Send + 'static, Global>
) -> Body

Converts to this type from the input type.

impl From<Bytes> for Body

fn from(bytes: Bytes) -> Body

Converts to this type from the input type.

impl From<Chunk> for Body

fn from(chunk: Chunk) -> Body

Converts to this type from the input type.

impl From<Cow<'static, [u8]>> for Body

fn from(cow: Cow<'static, [u8]>) -> Body

Converts to this type from the input type.

impl From<Cow<'static, str>> for Body

fn from(cow: Cow<'static, str>) -> Body

Converts to this type from the input type.

impl From<String> for Body

fn from(s: String) -> Body

Converts to this type from the input type.

impl From<Vec<u8, Global>> for Body

fn from(vec: Vec<u8, Global>) -> Body

Converts to this type from the input type.

impl Payload for Body

type 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>

Poll for a Data buffer. Read more

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

A hint that the Body is complete, and doesn’t need to be polled more. Read more

fn content_length(&self) -> Option<u64>

Return a length of the total bytes that will be streamed, if known. Read more

impl Stream for Body

type 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>

Attempt to pull out the next value of this stream, returning None if the stream is finished. Read more

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

fn into_future(self) -> StreamFuture<Self>where
Self: Sized,

Converts this stream into a Future. Read more

fn map<U, F>(self, f: F) -> Map<Self, F>where
F: FnMut(Self::Item) -> U,
Self: Sized,

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,
Self: Sized,

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,
Self: Sized,

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>,
Self: Sized,

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,
    Self: Sized,

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>,
    Self: Sized,

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>,
    Self: Sized,

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>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

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

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 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>,
    Self: Sized,

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>,
    Self: Sized,

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>,
Self: Sized,

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>where
Self: Sized,

Creates a new stream of at most amt items of the underlying stream. Read more

fn skip(self, amt: u64) -> Skip<Self>where
Self: Sized,

Creates a new stream which skips amt items of the underlying stream. Read more

fn fuse(self) -> Fuse<Self>where
Self: Sized,

Fuse a stream such that poll will never again be called once it has finished. Read more

fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,

Borrows a stream, rather than consuming it. Read more

fn merge<S>(self, other: S) -> Merge<Self, S>where
S: Stream<Error = Self::Error>,
Self: Sized,

👎Deprecated: 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>,
Self: Sized,

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>,
Self: Sized,

Adapter for chaining two stream. Read more

fn peekable(self) -> Peekable<Self>where
Self: Sized,

Creates a new stream which exposes a peek method. Read more

fn chunks(self, capacity: usize) -> Chunks<Self>where
Self: Sized,

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>,
Self: Sized,

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>,
    Self: Sized,

A future that completes after the given stream has been fully processed into the sink, including flushing. Read more

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

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

impl<T> Any for Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> StreamExt for Twhere
T: Stream + ?Sized,

fn throttle(self, duration: Duration) -> Throttle<Self>where
Self: Sized,

Throttle down the stream by enforcing a fixed delay between items. Read more

fn enumerate(self) -> Enumerate<Self>where
Self: Sized,

Creates a new stream which gives the current iteration count as well as the next value. Read more

fn timeout(self, timeout: Duration) -> Timeout<Self>where
Self: Sized,

Creates a new stream which allows self until timeout. Read more

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> Erased for T