Skip to main content

Helmet

Struct Helmet 

Source
pub struct Helmet { /* private fields */ }
Expand description

The set of security headers to apply to every response.

All headers are configured through a builder-style API. Call Helmet::new() (or Default::default()) to start from the secure defaults, then chain methods to customise individual headers.

§Examples

use rune_axum_helmet::{Helmet, Hsts, XFrameOptions};

let helmet = Helmet::new()
    .frame_options(XFrameOptions::Deny)
    .hsts(Hsts::new().max_age(63_072_000))
    .csp("default-src 'self'");

Implementations§

Source§

impl Helmet

Source

pub fn new() -> Helmet

Creates a new Helmet with secure defaults applied.

Source

pub fn frame_options(self, value: XFrameOptions) -> Helmet

Sets the X-Frame-Options header.

Source

pub fn no_frame_options(self) -> Helmet

Removes the X-Frame-Options header entirely.

Source

pub fn hsts(self, hsts: Hsts) -> Helmet

Sets the Strict-Transport-Security header.

Source

pub fn csp(self, policy: impl Into<String>) -> Helmet

Sets the Content-Security-Policy header to a raw policy string.

Source

pub fn referrer_policy(self, policy: ReferrerPolicy) -> Helmet

Sets the Referrer-Policy header.

Source

pub fn cross_origin_opener_policy( self, policy: CrossOriginOpenerPolicy, ) -> Helmet

Sets the Cross-Origin-Opener-Policy header.

Source

pub fn cross_origin_resource_policy( self, policy: CrossOriginResourcePolicy, ) -> Helmet

Sets the Cross-Origin-Resource-Policy header.

Source

pub fn cross_origin_embedder_policy( self, policy: CrossOriginEmbedderPolicy, ) -> Helmet

Sets the Cross-Origin-Embedder-Policy header.

Source

pub fn permissions_policy(self, policy: impl Into<String>) -> Helmet

Sets the Permissions-Policy header to a raw policy string.

Trait Implementations§

Source§

impl Clone for Helmet

Source§

fn clone(&self) -> Helmet

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Helmet

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Helmet

Source§

fn default() -> Helmet

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

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,