Struct poem::Request[−][src]

pub struct Request { /* fields omitted */ }

Expand description

Represents an HTTP request.

Implementations

[src]

impl Request

[src]

pub fn from_parts(parts: RequestParts, body: Body) -> Self

Creates a new Request with the given components parts and body.

[src]

pub fn builder() -> RequestBuilder

Creates a request builder.

[src]

pub fn method(&self) -> &Method

Returns a reference to the associated HTTP method.

[src]

pub fn set_method(&mut self, method: Method)

Sets the HTTP method for this request.

[src]

pub fn uri(&self) -> &Uri

Returns a reference to the associated URI.

[src]

pub fn uri_mut(&mut self) -> &mut Uri

Returns a mutable reference to the associated URI.

[src]

pub fn original_uri(&self) -> &Uri

Returns a reference to the associated original URI.

[src]

pub fn version(&self) -> Version

Returns the associated version.

[src]

pub fn set_version(&mut self, version: Version)

Sets the version for this request.

[src]

pub fn headers(&self) -> &HeaderMap

Returns a reference to the associated header map.

[src]

pub fn headers_mut(&mut self) -> &mut HeaderMap

Returns a mutable reference to the associated header map.

Returns the string value of the specified header.

NOTE: Returns None if the header value is not a valid UTF8 string.

[src]

pub fn path_param(&self, name: &str) -> Option<&str>

Returns the path parameter with the specified name.

[src]

pub fn deserialize_path<T: DeserializeOwned>(&self) -> Result<T, ParsePathError>

Deserialize path parameters.

pub fn deserialize_query<T: DeserializeOwned>(
&self
) -> Result<T, ParseQueryError>

Deserialize query parameters.

pub fn content_type(&self) -> Option<&str>

Returns the content type of this request.

[src]

pub fn extensions(&self) -> &Extensions

Returns a reference to the associated extensions.

[src]

pub fn extensions_mut(&mut self) -> &mut Extensions

Returns a mutable reference to the associated extensions.

[src]

pub fn data<T: Send + Sync + 'static>(&self) -> Option<&T>

Get a reference from extensions, similar to self.extensions().get().

[src]

pub fn set_data(&mut self, data: impl Send + Sync + 'static)

Inserts a value to extensions, similar to self.extensions().insert(data).

[src]

pub fn remote_addr(&self) -> &RemoteAddr

Returns a reference to the remote address.

[src]

pub fn local_addr(&self) -> &LocalAddr

Returns a reference to the local address.

This is supported on crate feature cookie only.

Returns a reference to the CookieJar

[src]

pub fn set_body(&mut self, body: impl Into<Body>)

Sets the body for this request.

[src]

pub fn take_body(&mut self) -> Body

Take the body from this request and sets the body to empty.

[src]

pub fn into_body(self) -> Body

Consume this request and return its inner body.

[src]

pub fn split(self) -> (Request, RequestBody )

Returns the parameters used by the extractor.

[src]

pub fn into_parts(self) -> (RequestParts, Body )

Consumes the request returning the head and body parts.

[src]

pub fn take_upgrade(&self) -> Result<OnUpgrade, UpgradeError>

Upgrade the connection and return a stream.

Trait Implementations

[src]

impl Debug for Request

[src]

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

Formats the value using the given formatter. Read more

[src]

impl Default for Request

[src]

fn default() -> Request

Returns the “default value” for a type. Read more

[src]

impl From<(Request<Body>, LocalAddr, RemoteAddr )> for Request

[src]

fn from(
(req, local_addr, remote_addr): (Request<Body>, LocalAddr, RemoteAddr )
) -> Self

Performs the conversion.

[src]

impl From<Request> for Request<Body>

[src]

fn from(req: Request) -> Self

Performs the conversion.

[src]

impl<'a> FromRequest<'a> for &'a Request

type Error = Infallible

The error type of this extractor. Read more

[src]

fn from_request<'life0, 'async_trait>(
 req: &'a Request,
 _body: &'life0 mut RequestBody
) -> Pin<Box<dyn Future<Output = Result<Self, Self::Error>> + Send + 'async_trait>> where
 'a: 'async_trait,
 'life0: 'async_trait,
 Self: 'async_trait,

Perform the extraction.

Auto Trait Implementations

impl !RefUnwindSafe for Request

impl Send for Request

impl Sync for Request

impl Unpin for Request

impl !UnwindSafe for Request

Blanket Implementations

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T> FutureExt for T

[src]

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

[src]

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

[src]

impl<T> Instrument for T

[src]

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

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

[src]

fn in_current_span(self) -> Instrumented<Self>

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

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<T> Same<T> for T

type Output = T

Should always be Self

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

type Error = >::Error

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

[src]

impl<T> WithSubscriber for T

[src]

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

[src]

fn with_current_subscriber(self) -> WithDispatch<Self>

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

Struct poem::Request[−][src]

Implementations

impl Request

pub fn from_parts(parts: RequestParts, body: Body) -> Self

pub fn builder() -> RequestBuilder

pub fn method(&self) -> &Method

pub fn set_method(&mut self, method: Method)

pub fn uri(&self) -> &Uri

pub fn uri_mut(&mut self) -> &mut Uri

pub fn original_uri(&self) -> &Uri

pub fn version(&self) -> Version

pub fn set_version(&mut self, version: Version)

pub fn headers(&self) -> &HeaderMap

pub fn headers_mut(&mut self) -> &mut HeaderMap

pub fn header(&self, name: impl AsRef<str>) -> Option<&str>

pub fn path_param(&self, name: &str) -> Option<&str>

pub fn deserialize_path<T: DeserializeOwned>(&self) -> Result<T, ParsePathError>

pub fn deserialize_query<T: DeserializeOwned>( &self) -> Result<T, ParseQueryError>

pub fn content_type(&self) -> Option<&str>

pub fn extensions(&self) -> &Extensions

pub fn extensions_mut(&mut self) -> &mut Extensions

pub fn data<T: Send + Sync + 'static>(&self) -> Option<&T>

pub fn set_data(&mut self, data: impl Send + Sync + 'static)

pub fn remote_addr(&self) -> &RemoteAddr

pub fn local_addr(&self) -> &LocalAddr

pub fn cookie(&self) -> &CookieJar

pub fn set_body(&mut self, body: impl Into<Body>)

pub fn take_body(&mut self) -> Body

pub fn into_body(self) -> Body

pub fn split(self) -> (Request, RequestBody)

pub fn into_parts(self) -> (RequestParts, Body)

pub fn take_upgrade(&self) -> Result<OnUpgrade, UpgradeError>

Trait Implementations

impl Debug for Request

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

impl Default for Request

fn default() -> Request

impl From<(Request<Body>, LocalAddr, RemoteAddr)> for Request

fn from( (req, local_addr, remote_addr): (Request<Body>, LocalAddr, RemoteAddr)) -> Self

impl From<Request> for Request<Body>

fn from(req: Request) -> Self

impl<'a> FromRequest<'a> for &'a Request

type Error = Infallible

fn from_request<'life0, 'async_trait>( req: &'a Request, _body: &'life0 mut RequestBody) -> Pin<Box<dyn Future<Output = Result<Self, Self::Error>> + Send + 'async_trait>> where 'a: 'async_trait, 'life0: 'async_trait, Self: 'async_trait,

Auto Trait Implementations

impl !RefUnwindSafe for Request

impl Send for Request

impl Sync for Request

impl Unpin for Request

impl !UnwindSafe for Request

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> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

fn with_current_context(self) -> WithContext<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> Same<T> for T

type Output = T

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<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

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 deserialize_query<T: DeserializeOwned>(
&self
) -> Result<T, ParseQueryError>

pub fn split(self) -> (Request, RequestBody )

pub fn into_parts(self) -> (RequestParts, Body )

impl From<(Request<Body>, LocalAddr, RemoteAddr )> for Request

fn from(
(req, local_addr, remote_addr): (Request<Body>, LocalAddr, RemoteAddr )
) -> Self

fn from_request<'life0, 'async_trait>(
req: &'a Request,
_body: &'life0 mut RequestBody
) -> Pin<Box<dyn Future<Output = Result<Self, Self::Error>> + Send + 'async_trait>> where
'a: 'async_trait,
'life0: 'async_trait,
Self: 'async_trait,

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

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