Struct hyperx::header::StrictTransportSecurity

pub struct StrictTransportSecurity {
    pub include_subdomains: bool,
    pub max_age: u64,
}

StrictTransportSecurity header, defined in RFC6797

This specification defines a mechanism enabling web sites to declare themselves accessible only via secure connections and/or for users to be able to direct their user agent(s) to interact with given sites only over secure connections. This overall policy is referred to as HTTP Strict Transport Security (HSTS). The policy is declared by web sites via the Strict-Transport-Security HTTP response header field and/or by other means, such as user agent configuration, for example.

ABNF

     [ directive ]  *( ";" [ directive ] )

     directive                 = directive-name [ "=" directive-value ]
     directive-name            = token
     directive-value           = token | quoted-string

Example values

• max-age=31536000
• max-age=15768000 ; includeSubDomains

Example

use hyperx::header::{StrictTransportSecurity, TypedHeaders};

let mut headers = http::HeaderMap::new();

headers.encode(
   &StrictTransportSecurity::including_subdomains(31536000u64)
);

Fields

include_subdomains: bool

Signals the UA that the HSTS Policy applies to this HSTS Host as well as any subdomains of the host’s domain name.

max_age: u64

Specifies the number of seconds, after the reception of the STS header field, during which the UA regards the host (from whom the message was received) as a Known HSTS Host.

Implementations

impl StrictTransportSecurity

pub fn including_subdomains(max_age: u64) -> StrictTransportSecurity

Create an STS header that includes subdomains

pub fn excluding_subdomains(max_age: u64) -> StrictTransportSecurity

Create an STS header that excludes subdomains

Trait Implementations

impl Clone for StrictTransportSecurity

fn clone(&self) -> StrictTransportSecurity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StrictTransportSecurity

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

Formats the value using the given formatter.

impl Display for StrictTransportSecurity

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

Formats the value using the given formatter.

impl FromStr for StrictTransportSecurity

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<StrictTransportSecurity>

Parses a string s to return a value of this type.

impl Header for StrictTransportSecurity

fn header_name() -> &'static str

Returns the name of the header field this belongs to.

fn parse_header<'a, T>(raw: &'a T) -> Result<StrictTransportSecurity> where
    T: RawLike<'a>, 

Parse a header from a raw stream of bytes.

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

Format a header to outgoing stream.

impl PartialEq<StrictTransportSecurity> for StrictTransportSecurity

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

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

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

This method tests for !=.

impl StandardHeader for StrictTransportSecurity

fn http_header_name() -> HeaderName

The HeaderName from the http crate for this header.

impl StructuralPartialEq for StrictTransportSecurity