Struct poem::web::Redirect

pub struct Redirect { /* private fields */ }

Expand description

A redirect response.

Example

use poem::{
    get, handler,
    http::{header, HeaderValue, StatusCode, Uri},
    web::Redirect,
    Endpoint, Request, Route,
};

#[handler]
async fn index() -> Redirect {
    Redirect::moved_permanent(Uri::from_static("https://www.google.com"))
}

let app = Route::new().at("/", get(index));
let resp = app.call(Request::default()).await.unwrap();
assert_eq!(resp.status(), StatusCode::MOVED_PERMANENTLY);
assert_eq!(
    resp.headers().get(header::LOCATION),
    Some(&HeaderValue::from_static("https://www.google.com/"))
);

Implementations

impl Redirect

pub fn permanent(uri: Uri) -> Self

A simple 308 permanent redirect to a different location.

pub fn moved_permanent(uri: Uri) -> Self

A simple 301 permanent redirect to a different location.

pub fn see_other(uri: Uri) -> Self

A simple 303 redirect to a different location.

pub fn temporary(uri: Uri) -> Self

A simple 307 temporary redirect to a different location.

Trait Implementations

impl Clone for Redirect

fn clone(&self) -> Redirect

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for Redirect

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

Formats the value using the given formatter. Read more

impl IntoResponse for Redirect

fn into_response(self) -> Response

Consume itself and return Response.

fn with_header<K, V>(self, key: K, value: V) -> WithHeader<Self> where
    K: TryInto<HeaderName>,
    V: TryInto<HeaderValue>,
    Self: Sized,

Wrap an impl IntoResponse to add a header. Read more

fn with_status(self, status: StatusCode) -> WithStatus<Self> where
Self: Sized,

Wrap an impl IntoResponse to set a status code. Read more

fn with_body(self, body: impl Into<Body>) -> WithBody<Self> where
Self: Sized,

Wrap an impl IntoResponse to set a body. Read more

impl PartialEq<Redirect> for Redirect

fn eq(&self, other: &Redirect) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

fn ne(&self, other: &Redirect) -> bool

This method tests for !=.

impl Eq for Redirect

impl StructuralEq for Redirect

impl StructuralPartialEq for Redirect

Auto Trait Implementations

impl RefUnwindSafe for Redirect

impl Send for Redirect

impl Sync for Redirect

impl Unpin for Redirect

impl UnwindSafe for Redirect

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> AnyEq for T where
T: Any + PartialEq<T>,

pub fn equals(&self, other: &(dyn Any + 'static)) -> bool

pub fn as_any(&self) -> &(dyn Any + 'static)

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

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

pub fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

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

pub fn into(self) -> U

Performs the conversion.

impl<T> IntoResult<T> for T where
T: IntoResponse,

pub fn into_result(Self) -> Result<T, Error>

Consumes this value returns a poem::Result<T>.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

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

pub 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