Struct HookMetadata 

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

kind: String

subject: Option<String>

callback: Option<HookCallbackRoute>

labels: BTreeMap<String, String>

data: BTreeMap<String, JsonValue>

Implementations

impl HookMetadata

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

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

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

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

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

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

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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