1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
//! Redirect requests to a new location. //! //! The types in this module are helpers that implement [`Reply`](Reply), and easy //! to use in order to setup redirects. use http::{header, StatusCode}; use self::sealed::AsLocation; use crate::reply::{self, Reply}; /// A simple `301` permanent redirect to a different location. /// /// # Example /// /// ``` /// use warp::{http::Uri, Filter}; /// /// let route = warp::path("v1") /// .map(|| { /// warp::redirect(Uri::from_static("/v2")) /// }); /// ``` pub fn redirect(uri: impl AsLocation) -> impl Reply { reply::with_header( StatusCode::MOVED_PERMANENTLY, header::LOCATION, uri.header_value(), ) } /// A simple `303` redirect to a different location. /// /// The HTTP method of the request to the new location will always be `GET`. /// /// # Example /// /// ``` /// use warp::{http::Uri, Filter}; /// /// let route = warp::path("v1") /// .map(|| { /// warp::redirect::see_other(Uri::from_static("/v2")) /// }); /// ``` pub fn see_other(uri: impl AsLocation) -> impl Reply { reply::with_header(StatusCode::SEE_OTHER, header::LOCATION, uri.header_value()) } /// A simple `307` temporary redirect to a different location. /// /// This is similar to [`see_other`](fn@see_other) but the HTTP method and the body of the request /// to the new location will be the same as the method and body of the current request. /// /// # Example /// /// ``` /// use warp::{http::Uri, Filter}; /// /// let route = warp::path("v1") /// .map(|| { /// warp::redirect::temporary(Uri::from_static("/v2")) /// }); /// ``` pub fn temporary(uri: impl AsLocation) -> impl Reply { reply::with_header( StatusCode::TEMPORARY_REDIRECT, header::LOCATION, uri.header_value(), ) } /// A simple `308` permanent redirect to a different location. /// /// This is similar to [`redirect`](fn@redirect) but the HTTP method of the request to the new /// location will be the same as the method of the current request. /// /// # Example /// /// ``` /// use warp::{http::Uri, Filter}; /// /// let route = warp::path("v1") /// .map(|| { /// warp::redirect::permanent(Uri::from_static("/v2")) /// }); /// ``` pub fn permanent(uri: impl AsLocation) -> impl Reply { reply::with_header( StatusCode::PERMANENT_REDIRECT, header::LOCATION, uri.header_value(), ) } mod sealed { use bytes::Bytes; use http::{header::HeaderValue, Uri}; // These sealed traits are to allow adding possibly new impls so other // arguments could be accepted, like maybe just `warp::redirect("/v2")`. pub trait AsLocation: Sealed {} pub trait Sealed { fn header_value(self) -> HeaderValue; } impl AsLocation for Uri {} impl Sealed for Uri { fn header_value(self) -> HeaderValue { let bytes = Bytes::from(self.to_string()); HeaderValue::from_maybe_shared(bytes).expect("Uri is a valid HeaderValue") } } }