Struct AuthRequest 

pub struct AuthRequest {
    pub method: HttpMethod,
    pub path: String,
    pub headers: HashMap<String, String>,
    pub body: Option<Vec<u8>>,
    pub query: HashMap<String, String>,
    /* private fields */
}

Authentication request wrapper

Fields

method: HttpMethod

path: String

headers: HashMap<String, String>

body: Option<Vec<u8>>

query: HashMap<String, String>

Implementations

impl AuthRequest

pub fn new(method: HttpMethod, path: impl Into<String>) -> AuthRequest

pub fn from_parts( method: HttpMethod, path: String, headers: HashMap<String, String>, body: Option<Vec<u8>>, query: HashMap<String, String>, ) -> AuthRequest

Construct a request from all public parts.

Prefer AuthRequest::new when you only need method + path.

pub fn method(&self) -> &HttpMethod

pub fn path(&self) -> &str

pub fn header(&self, name: &str) -> Option<&String>

pub fn virtual_user_id(&self) -> Option<&str>

Returns the virtual user ID injected by a before_request hook, if any.

pub fn set_virtual_user_id(&mut self, user_id: String)

Set the virtual user ID on this request.

Safety contract

This must only be called from the internal request pipeline (i.e. handle_request_inner) after a plugin’s before_request hook returns BeforeRequestAction::InjectSession. Calling it from application code would bypass normal authentication.

pub fn body_as_json<T>(&self) -> Result<T, Error>

where T: for<'de> Deserialize<'de>,

Trait Implementations

impl Clone for AuthRequest

fn clone(&self) -> AuthRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthRequest

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

Formats the value using the given formatter.