Struct HookMetadata 

#[non_exhaustive]
pub struct HookMetadata {
    pub kind: String,
    pub subject: Option<String>,
    pub callback: Option<HookCallbackRoute>,
    pub labels: BTreeMap<String, String>,
    pub data: BTreeMap<String, JsonValue>,
}

Typed helper for common hook metadata fields.

Hook metadata is still persisted as JSON in flow.hook.created events. This type only gives Rust workflow authors a stable shape for audit and callback routing fields.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

kind: String

Application-defined hook kind used for routing and audit.

subject: Option<String>

Optional human-readable subject.

callback: Option<HookCallbackRoute>

Optional callback route exposed by the host.

labels: BTreeMap<String, String>

Searchable string labels.

data: BTreeMap<String, JsonValue>

Application-defined structured metadata.

Implementations

impl HookMetadata

pub fn new(kind: impl Into<String>) -> Self

Creates metadata for an application-defined hook kind.

pub fn human_approval(subject: impl Into<String>) -> Self

Creates metadata for a human-approval hook.

pub fn with_subject(self, subject: impl Into<String>) -> Self

Sets the human-readable subject.

pub fn with_callback_route(self, callback: HookCallbackRoute) -> Self

Sets the host callback route.

pub fn with_label( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Adds or replaces one searchable label.

pub fn with_data( self, key: impl Into<String>, value: impl Into<JsonValue>, ) -> Self

Adds or replaces one structured metadata value.

pub fn into_json(self) -> Result<JsonValue>

Serializes the typed metadata into its durable JSON representation.

Trait Implementations

impl Clone for HookMetadata

fn clone(&self) -> HookMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HookMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HookMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for HookMetadata

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for HookMetadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HookMetadata