Struct HookPayload 

pub struct HookPayload {
    pub event: HookEvent,
    pub hook_id: String,
    pub context: HookContext,
    pub ts: DateTime<Utc>,
    pub data: Value,
}

Structured input delivered to one hook invocation.

Fields

event: HookEvent

Lifecycle point being fired.

hook_id: String

Stable id of the receiving hook.

context: HookContext

Session and turn correlation. Flattened to top-level session_id and turn_id fields on the JSON wire.

ts: DateTime<Utc>

Invocation timestamp.

data: Value

Event-specific data. Its documented shape is part of the public hook contract even though it stays JSON so executors can be language-neutral.

Implementations

impl HookPayload

pub fn new( event: HookEvent, hook_id: impl Into<String>, context: HookContext, data: Value, ) -> HookPayload

Build a payload for a particular hook.

Trait Implementations

impl Clone for HookPayload

fn clone(&self) -> HookPayload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HookPayload

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HookPayload

fn deserialize<__D>( __deserializer: __D, ) -> Result<HookPayload, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for HookPayload

fn eq(&self, other: &HookPayload) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for HookPayload

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HookPayload