Struct Intervention 

pub struct Intervention {
    pub status: u16,
    pub url: Option<String>,
    pub log: Option<String>,
    pub rule_ids: Vec<String>,
    pub phase: Phase,
    pub drop_connection: bool,
    pub metadata: Vec<RuleMetadata>,
}

An intervention (blocking decision) from rule processing.

Fields

status: u16

HTTP status code to return.

url: Option<String>

Redirect URL (if applicable).

log: Option<String>

Log message.

rule_ids: Vec<String>

Rule IDs that triggered the intervention.

phase: Phase

Phase in which intervention occurred.

drop_connection: bool

Whether to drop the connection.

metadata: Vec<RuleMetadata>

Matched rule metadata.

Implementations

impl Intervention

pub fn new(status: u16, phase: Phase) -> Self

Create a new intervention.

pub fn deny(status: u16, phase: Phase, rule_id: Option<String>) -> Self

Create a deny intervention.

pub fn redirect(url: String, phase: Phase, rule_id: Option<String>) -> Self

Create a redirect intervention.

pub fn drop(phase: Phase, rule_id: Option<String>) -> Self

Create a drop intervention.

pub fn add_rule_id(&mut self, id: String)

Add a rule ID.

pub fn add_metadata(&mut self, metadata: RuleMetadata)

Add metadata from a matched rule.

pub fn set_log(&mut self, log: String)

Set log message.

pub fn format_log(&self) -> String

Format as a log entry.

Trait Implementations

impl Clone for Intervention

fn clone(&self) -> Intervention

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Intervention

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

Formats the value using the given formatter.

impl Default for Intervention

fn default() -> Self

Returns the “default value” for a type.