Struct poem::Request

pub struct Request { /* private fields */ }

Expand description

Represents an HTTP request.

Implementations§

impl Request

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

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

pub fn builder() -> RequestBuilder

Creates a request builder.

pub fn method(&self) -> &Method

Returns a reference to the associated HTTP method.

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

Sets the HTTP method for this request.

pub fn uri(&self) -> &Uri

Returns a reference to the associated URI.

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

Returns a mutable reference to the associated URI.

pub fn original_uri(&self) -> &Uri

Returns a reference to the associated original URI.

pub fn version(&self) -> Version

Returns the associated version.

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

Sets the version for this request.

pub fn scheme(&self) -> &Scheme

Returns the scheme of incoming request.

pub fn headers(&self) -> &HeaderMap

Returns a reference to the associated header map.

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.

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

Returns the raw path parameter with the specified name.

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

Deserialize path parameters.

See also Path

§Example

use poem::{
    handler,
    http::{StatusCode, Uri},
    test::TestClient,
    Endpoint, Request, Result, Route,
};

#[handler]
fn index(req: &Request) -> Result<String> {
    let (a, b) = req.path_params::<(i32, String)>()?;
    Ok(format!("{}:{}", a, b))
}

let app = Route::new().at("/:a/:b", index);
let cli = TestClient::new(app);

let resp = cli.get("/100/abc").send().await;
resp.assert_status_is_ok();
resp.assert_text("100:abc").await;

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

Deserialize query parameters.

See also Query

§Example

use poem::{
    handler,
    http::{StatusCode, Uri},
    test::TestClient,
    Endpoint, Request, Result, Route,
};
use serde::Deserialize;

#[derive(Deserialize)]
struct Params {
    a: i32,
    b: String,
}

#[handler]
fn index(req: &Request) -> Result<String> {
    let params = req.params::<Params>()?;
    Ok(format!("{}:{}", params.a, params.b))
}

let app = Route::new().at("/", index);
let cli = TestClient::new(app);

let resp = cli
    .get("/")
    .query("a", &100)
    .query("b", &"abc")
    .send()
    .await;
resp.assert_status_is_ok();
resp.assert_text("100:abc").await;

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

Returns the content type of this request.

pub fn extensions(&self) -> &Extensions

Returns a reference to the associated extensions.

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

Returns a mutable reference to the associated extensions.

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

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

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

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

pub fn remote_addr(&self) -> &RemoteAddr

Returns a reference to the remote address.

pub fn local_addr(&self) -> &LocalAddr

Returns a reference to the local address.

Available on crate feature cookie only.

Returns a reference to the CookieJar

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

Sets the body for this request.

pub fn take_body(&mut self) -> Body

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

pub fn into_body(self) -> Body

Consume this request and return its inner body.

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

Returns the parameters used by the extractor.

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

Consumes the request returning the head and body parts.

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

Upgrade the connection and return a stream.

Trait Implementations§

impl Debug for Request

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

Formats the value using the given formatter. Read more

impl Default for Request

fn default() -> Request

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

impl From<(Request<Incoming>, LocalAddr, RemoteAddr, Scheme)> for Request

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

Converts to this type from the input type.

impl From<Request> for Request<BoxBody<Bytes, Error>>

fn from(req: Request) -> Self

Converts to this type from the input type.

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

async fn from_request(req: &'a Request, _body: &mut RequestBody) -> Result<Self>

Extract from request head and body.

fn from_request_without_body( req: &'a Request ) -> impl Future<Output = Result<Self>> + Send

Extract from request head. Read more

Auto Trait Implementations§

impl !Freeze for Request

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,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32 ) -> TaggedParser<'a, Implicit, Self, E>

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FutureExt for T

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

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

fn with_current_context(self) -> WithContext<Self>

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

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

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

type Output = T

Should always be Self

impl<T> TowerCompatExt for T

fn compat<ResBody, Err, Fut>(self) -> TowerCompatEndpoint<Self>
where ResBody: Body + Send + Sync + 'static, ResBody::Data: Into<Bytes> + Send + 'static, ResBody::Error: StdError + Send + Sync + 'static, Err: Into<Error>, Self: Service<Request<BoxBody<Bytes, Error>>, Response = Response<ResBody>, Error = Err, Future = Fut> + Clone + Send + Sync + Sized + 'static, Fut: Future<Output = Result<Response<ResBody>, Err>> + Send + 'static,

Available on crate feature tower-compat only.

Converts a tower service to a poem endpoint.

impl<L> TowerLayerCompatExt for L

fn compat(self) -> TowerCompatMiddleware<Self>
where Self: Sized,

Available on crate feature tower-compat only.

Converts a tower layer to a poem middleware.

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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