Struct Hooks 

pub struct Hooks {

    pub before_list: Option<String>,
    pub after_list: Option<String>,
    pub before_read: Option<String>,
    pub after_read: Option<String>,
    pub before_create: Option<String>,
    pub after_create: Option<String>,
    pub before_update: Option<String>,
    pub after_update: Option<String>,
    pub before_delete: Option<String>,
    pub after_delete: Option<String>,
    pub before_register: Option<String>,
    pub after_register: Option<String>,
    pub before_login: Option<String>,
    pub after_login: Option<String>,
    pub before_api_key: Option<String>,
    pub after_api_key: Option<String>,
}

The [hooks] section of a resource: a function name per lifecycle event.

Unknown keys are rejected so a typo (befor_create) fails at load time instead of silently never firing.

The AuthEvent keys live here too, and are only meaningful on the user resource — declaring one anywhere else fails validation, since nothing would ever fire it.

Fields

before_list: Option<String>

after_list: Option<String>

before_read: Option<String>

after_read: Option<String>

before_create: Option<String>

after_create: Option<String>

before_update: Option<String>

after_update: Option<String>

before_delete: Option<String>

after_delete: Option<String>

before_register: Option<String>

after_register: Option<String>

before_login: Option<String>

after_login: Option<String>

before_api_key: Option<String>

after_api_key: Option<String>

Implementations

impl Hooks

pub fn get(&self, event: HookEvent) -> Option<&str>

The function bound to an event, if any.

pub fn iter(&self) -> impl Iterator<Item = (HookEvent, &str)>

Every declared (event, function) pair, in lifecycle order.

pub fn is_empty(&self) -> bool

Whether any hook at all is declared, auth events included.

impl Hooks

pub fn get_auth(&self, event: AuthEvent) -> Option<&str>

The function bound to an auth event, if any.

pub fn auth_iter(&self) -> impl Iterator<Item = (AuthEvent, &str)>

Every declared auth (event, function) pair, in lifecycle order.

Trait Implementations

impl Clone for Hooks

fn clone(&self) -> Hooks

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Hooks

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

Formats the value using the given formatter.

impl Default for Hooks

fn default() -> Hooks

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Hooks

where Hooks: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.