Enum rocket::http::ProxyProto

pub enum ProxyProto<'a> {
    Http,
    Https,
    Unknown(&'a UncasedStr),
}

Parsed Config::proxy_proto_header value: identifies a forwarded HTTP protocol (aka X-Forwarded-Proto).

The value of the header with name Config::proxy_proto_header is parsed case-insensitively into this enum. For a given request, the parsed value, if the header was present, can be retrieved via Request::proxy_proto() or directly as a request guard. That value is used to determine whether a request’s context is likely secure (Request::context_is_likely_secure()) which in-turn is used to determine whether the Secure cookie flag is set by default when cookies are added to a CookieJar.

Variants

Http

"http": Hypertext Transfer Protocol.

Https

"https": Hypertext Transfer Protocol Secure.

Unknown(&'a UncasedStr)

Any protocol name other than "http" or "https".

Implementations

impl ProxyProto<'_>

pub fn is_https(&self) -> bool

Returns true if self is ProxyProto::Https and false otherwise.

Example

use rocket::http::ProxyProto;

assert!(ProxyProto::Https.is_https());
assert!(!ProxyProto::Http.is_https());

Trait Implementations

impl<'a> Clone for ProxyProto<'a>

fn clone(&self) -> ProxyProto<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ProxyProto<'a>

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

Formats the value using the given formatter.

impl Display for ProxyProto<'_>

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

Formats the value using the given formatter.

impl<'a> From<&'a str> for ProxyProto<'a>

fn from(value: &'a str) -> ProxyProto<'a>

Converts to this type from the input type.

impl<'r> FromRequest<'r> for ProxyProto<'r>

type Error = Infallible

The associated error to be returned if derivation fails.

fn from_request<'life0, 'async_trait>( request: &'r Request<'life0> ) -> Pin<Box<dyn Future<Output = Outcome<Self, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'r: 'async_trait, 'life0: 'async_trait,

Derives an instance of Self from the incoming request metadata.

impl<'a> PartialEq for ProxyProto<'a>

fn eq(&self, other: &ProxyProto<'a>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Eq for ProxyProto<'a>

impl<'a> StructuralPartialEq for ProxyProto<'a>