Struct Hook 

pub struct Hook {
    pub event: HookEventName,
    pub matcher: Option<String>,
    pub timeout: Duration,
    pub status_message: Option<String>,
    pub if_condition: Option<String>,
    pub once: bool,
    pub kind: HookKind,
}

SDK hook definition registered into a builder.

Fields

event: HookEventName

matcher: Option<String>

timeout: Duration

status_message: Option<String>

if_condition: Option<String>

once: bool

kind: HookKind

Implementations

impl Hook

pub fn callback<F, Fut, R>(event: HookEventName, callback: F) -> Self

where F: Fn(HookInput) -> Fut + Send + Sync + 'static, Fut: Future<Output = R> + Send + 'static, R: IntoHookResponse + 'static,

Create a callback hook for an event.

pub fn function<Factory, F, Fut, R>( event: HookEventName, factory: Factory, ) -> Self

where Factory: Fn() -> F + Send + Sync + 'static, F: Fn(HookInput) -> Fut + Send + Sync + 'static, Fut: Future<Output = R> + Send + 'static, R: IntoHookResponse + 'static,

Create a hook that builds its callback per dispatch.

pub fn with_matcher(self, matcher: impl Into<String>) -> Self

Restrict the hook to matching event values.

pub fn with_timeout(self, timeout: Duration) -> Self

Override the hook timeout.

pub fn with_status_message(self, status_message: impl Into<String>) -> Self

Set the status message shown while the hook runs.

pub fn with_if_condition(self, if_condition: impl Into<String>) -> Self

Set a simple hook condition expression.

pub fn with_once(self, once: bool) -> Self

Run this hook only once per session when true.

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.