Struct Csrf 

pub struct Csrf { /* private fields */ }

A Handler that rejects state-changing cross-origin requests.

See the crate-level docs for the exact decision sequence. Construct with csrf or Csrf::new and place it in the handler tuple before any handler with side effects.

Implementations

impl Csrf

pub const fn new() -> Self

Constructs a new Csrf handler with no trusted origins.

pub fn with_trusted_origins<I>(self, origins: I) -> Self

where I: IntoIterator, I::Item: AsRef<str>,

Allows cross-origin requests from these origins.

Each entry must be a full origin — scheme, host, and optional port, such as "https://app.example.com" — with nothing else. Requests are compared by exact origin: no wildcards, and subdomains of a trusted origin are not trusted.

use trillium_csrf::csrf;
let handler = csrf().with_trusted_origins(["https://app.example.com"]);

Panics

Panics if an entry is not parseable as an origin, is not http or https, or contains a path, query, or credentials. A path would be silently ignored during comparison, so an entry like "https://example.com/app" is rejected rather than matching more broadly than it reads.

Trait Implementations

impl Debug for Csrf

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

Formats the value using the given formatter.

impl Default for Csrf

fn default() -> Self

Returns the “default value” for a type.

impl Handler for Csrf

async fn run(&self, conn: Conn) -> Conn

Executes this handler, performing any modifications to the Conn that are desired.

fn init(&mut self, info: &mut Info) -> impl Future<Output = ()> + Send

Performs one-time async set up on a mutable borrow of the Handler before the server starts accepting requests. This allows a Handler to be defined in synchronous code but perform async setup such as establishing a database connection or fetching some state from an external source. This is optional, and chances are high that you do not need this.

fn before_send(&self, conn: Conn) -> impl Future<Output = Conn> + Send

Performs any final modifications to this conn after all handlers have been run. Although this is a slight deviation from the simple conn->conn->conn chain represented by most Handlers, it provides an easy way for libraries to effectively inject a second handler into a response chain. This is useful for loggers that need to record information both before and after other handlers have run, as well as database transaction handlers and similar library code.

fn has_upgrade(&self, upgrade: &Upgrade) -> bool

predicate function answering the question of whether this Handler would like to take ownership of the negotiated Upgrade. If this returns true, you must implement Handler::upgrade. The first handler that responds true to this will receive ownership of the trillium::Upgrade in a subsequent call to Handler::upgrade

fn upgrade(&self, upgrade: Upgrade) -> impl Future<Output = ()> + Send

This will only be called if the handler reponds true to Handler::has_upgrade and will only be called once for this upgrade. There is no return value, and this function takes exclusive ownership of the underlying transport once this is called. You can downcast the transport to whatever the source transport type is and perform any non-http protocol communication that has been negotiated. You probably don’t want this unless you’re implementing something like websockets. Please note that for many transports such as TcpStreams, dropping the transport (and therefore the Upgrade) will hang up / disconnect.

fn name(&self) -> Cow<'static, str>

Customize the name of your handler. This is used in Debug implementations. The default is the type name of this handler.