Struct Hook 

pub struct Hook {

    pub event: String,
    pub action: String,
    pub phase: String,
    pub resource: String,
    pub url: String,
    pub method: String,
    pub query: BTreeMap<String, String>,
    pub authenticated: bool,
    pub principal_id: Option<String>,
    pub organization_id: Option<String>,
    pub role: Option<String>,
    pub roles: Vec<String>,
    pub record_id: Option<String>,
    pub data: Option<Value>,
    pub row: Option<Value>,
    pub rows: Option<Vec<Value>>,
}

Everything the host knows about the operation a hook fired for.

Reachable through Context::hook. Every field is optional on the wire, so a function written against an older host still loads; unknown fields are ignored, so a newer host can add more.

Fields

event: String

The lifecycle event, e.g. "before_create" or "after_list".

action: String

The operation: "list", "read", "create", "update" or "delete".

phase: String

"before" or "after".

resource: String

The resource the hook is attached to, e.g. "post".

url: String

Path and query string of the request that triggered the hook.

method: String

HTTP method of that request.

query: BTreeMap<String, String>

Parsed query parameters.

authenticated: bool

Whether the caller is authenticated.

principal_id: Option<String>

The caller’s user id, when authenticated.

organization_id: Option<String>

The caller’s active organisation, when one is resolved.

role: Option<String>

The caller’s primary role in that organisation, when they have one.

roles: Vec<String>

Every role they hold there. A member can hold several, and this is what a role: permission is checked against — so prefer it to role when deciding what somebody may do.

record_id: Option<String>

The id in the URL for single-record operations (read/update/delete).

data: Option<Value>

The submitted body on before_create / before_update.

row: Option<Value>

The row created, fetched, updated or about to be deleted.

rows: Option<Vec<Value>>

The rows a list returned, on after_list.

Implementations

impl Hook

pub fn parse(json: &str) -> Option<Hook>

Parse a hook context, or None when the string is empty or malformed (i.e. this was a plain HTTP invocation).

pub fn is_before(&self) -> bool

Whether this hook runs before the database operation (and so can still rewrite the payload or abort).

pub fn is_after(&self) -> bool

Whether this hook runs after the operation succeeded.

pub fn data(&self) -> &Value

The submitted body, or null when the event carries none.

pub fn row(&self) -> &Value

The row in play, or null when the event carries none.

pub fn rows(&self) -> &[Value]

The rows a list returned; empty for every other event.

pub fn field(&self, name: &str) -> Option<&Value>

Read a field from whichever subject the event carries — the submitted data for before_create/before_update, else the row.

Trait Implementations

impl Clone for Hook

fn clone(&self) -> Hook

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Hook

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

Formats the value using the given formatter.

impl Default for Hook

fn default() -> Hook

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Hook

where Hook: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.