Trait HttpMessage 

pub trait HttpMessage: Sized {
    type Stream;

    // Required methods
    fn headers(&self) -> &HeaderMap;
    fn take_payload(&mut self) -> Payload<Self::Stream>;
    fn extensions(&self) -> Ref<'_, Extensions>;
    fn extensions_mut(&self) -> RefMut<'_, Extensions>;

    // Provided methods
    fn content_type(&self) -> &str { ... }
    fn encoding(&self) -> Result<&'static Encoding, ContentTypeError> { ... }
    fn mime_type(&self) -> Result<Option<Mime>, ContentTypeError> { ... }
    fn chunked(&self) -> Result<bool, ParseError> { ... }
    fn cookies(&self) -> Result<Ref<'_, Vec<Cookie<'static>>>, ParseError> { ... }
    fn cookie(&self, name: &str) -> Option<Cookie<'static>> { ... }
}

Trait that implements general purpose operations on http messages

Required Associated Types

type Stream

Type of message payload stream

Required Methods

fn headers(&self) -> &HeaderMap

Read the message headers.

fn take_payload(&mut self) -> Payload<Self::Stream>

Message payload stream

fn extensions(&self) -> Ref<'_, Extensions>

Request’s extensions container

fn extensions_mut(&self) -> RefMut<'_, Extensions>

Mutable reference to a the request’s extensions container

Provided Methods

fn content_type(&self) -> &str

Read the request content type. If request does not contain Content-Type header, empty str get returned.

fn encoding(&self) -> Result<&'static Encoding, ContentTypeError>

Get content type encoding

UTF-8 is used by default, If request charset is not set.

fn mime_type(&self) -> Result<Option<Mime>, ContentTypeError>

Convert the request content type to a known mime type.

fn chunked(&self) -> Result<bool, ParseError>

Check if request has chunked transfer encoding

fn cookies(&self) -> Result<Ref<'_, Vec<Cookie<'static>>>, ParseError>

Load request cookies.

fn cookie(&self, name: &str) -> Option<Cookie<'static>>

Return request cookie.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<'a, T> HttpMessage for &'a mut T

where T: HttpMessage,

fn take_payload(&mut self) -> Payload<<&'a mut T as HttpMessage>::Stream>

Message payload stream

fn extensions(&self) -> Ref<'_, Extensions>

Request’s extensions container

fn extensions_mut(&self) -> RefMut<'_, Extensions>

Mutable reference to a the request’s extensions container

type Stream = <T as HttpMessage>::Stream

fn headers(&self) -> &HeaderMap

Implementors

impl HttpMessage for ServiceRequest

type Stream = Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>>>>

impl HttpMessage for HttpRequest

type Stream = ()

impl<P> HttpMessage for Request<P>

type Stream = P

impl<S> HttpMessage for ClientResponse<S>

type Stream = S