Struct hyper::Body

source · [−]

pub struct Body { /* private fields */ }

Expand description

A stream of Bytes, used when receiving bodies.

A good default HttpBody to use in many applications.

Implementations

source

impl Body

source

pub fn empty() -> Body

Create an empty Body stream.

Example

use hyper::{Body, Request};

// create a `GET /` request
let get = Request::new(Body::empty());

source

pub fn channel() -> (Sender, Body )

Create a Body stream with an associated sender half.

Useful when wanting to stream chunks from another thread.

source

pub fn on_upgrade(self) -> OnUpgradeⓘNotable traits for OnUpgrade`impl Future for OnUpgrade type Output = Result<Upgraded, Error>;`

Converts this Body into a Future of a pending HTTP upgrade.

See the upgrade module for more.

Trait Implementations

source

impl Body for Body

type Data = Bytes

Values yielded by the Body.

type Error = Error

The error type this Body might generate.

source

fn poll_data(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Result<Self::Data, Self::Error>>>

Attempt to pull out the next data buffer of this stream.

source

fn poll_trailers(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<Option<HeaderMap>, Self::Error>>

Poll for an optional single HeaderMap of trailers. Read more

source

fn is_end_stream(&self) -> bool

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

source

fn size_hint(&self) -> SizeHint

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

source

fn data(&mut self) -> Data<'_, Self> where
Self: Unpin,

Returns future that resolves to next data chunk, if any.

source

fn trailers(&mut self) -> Trailers<'_, Self> where
Self: Unpin,

Returns future that resolves to trailers, if any.

source

impl Debug for Body

source

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

Formats the value using the given formatter. Read more

source

impl Default for Body

source

fn default() -> Body

Returns Body::empty().

source

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

source

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

Performs the conversion.

source

impl From<&'static str> for Body

source

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

Performs the conversion.

source

impl From<Bytes> for Body

source

fn from(chunk: Bytes) -> Body

Performs the conversion.

source

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

source

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

Performs the conversion.

source

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

source

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

Performs the conversion.

source

impl From<String> for Body

source

fn from(s: String) -> Body

Performs the conversion.

source

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

source

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

Performs the conversion.

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> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

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

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct hyper::Body

Implementations

impl Body

pub fn empty() -> Body

pub fn channel() -> (Sender, Body)

pub fn on_upgrade(self) -> OnUpgradeⓘNotable traits for OnUpgradeimpl Future for OnUpgrade type Output = Result<Upgraded, Error>;

Trait Implementations

impl Body for Body

type Data = Bytes

type Error = Error

fn poll_data( self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Result<Self::Data, Self::Error>>>

fn poll_trailers( self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<Option<HeaderMap>, Self::Error>>

fn is_end_stream(&self) -> bool

fn size_hint(&self) -> SizeHint

fn data(&mut self) -> Data<'_, Self> where Self: Unpin,

fn trailers(&mut self) -> Trailers<'_, Self> where Self: Unpin,

impl Debug for Body

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

impl Default for Body

fn default() -> Body

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

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

impl From<&'static str> for Body

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

impl From<Bytes> for Body

fn from(chunk: Bytes) -> Body

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

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

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

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

impl From<String> for Body

fn from(s: String) -> Body

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

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

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 T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

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

type Error = Infallible

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

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

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

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

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn channel() -> (Sender, Body )

pub fn on_upgrade(self) -> OnUpgradeⓘNotable traits for OnUpgrade`impl Future for OnUpgrade type Output = Result<Upgraded, Error>;`

fn poll_data(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Result<Self::Data, Self::Error>>>

fn poll_trailers(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<Option<HeaderMap>, Self::Error>>

fn data(&mut self) -> Data<'_, Self> where
Self: Unpin,

fn trailers(&mut self) -> Trailers<'_, Self> where
Self: Unpin,

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

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

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

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

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

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

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

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

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,