Struct VaultEventEnvelope 

#[non_exhaustive]
pub struct VaultEventEnvelope {
    pub epoch: String,
    pub sequence: u64,
    pub observed_at_ms: u64,
    pub vault: String,
    pub event: HookEvent,
    pub content_hash: Option<String>,
    pub plugin_id: Option<String>,
    pub attribution: EventAttribution,
}

Sequenced event delivered to hook subscribers.

Sequence numbers are assigned and the envelope is enqueued inside one critical section, so subscribers observe events in sequence order.

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.

epoch: String

Identifier of the bus run that issued Self::sequence.

See HookBus::epoch. Persist it alongside the sequence — an EventCursor does this — or the number means nothing after a restart.

sequence: u64

Sequence number, monotonic within Self::epoch and only there.

It counts from zero each time the host starts.

observed_at_ms: u64

Observation time as Unix epoch milliseconds.

vault: String

Vault name.

event: HookEvent

Observed mutation.

content_hash: Option<String>

Content identity when it was available at observation time.

plugin_id: Option<String>

Mounted plugin namespace the host attributes this write to.

Stamped by the host from the validated descriptor of the plugin whose call produced the write, and not settable by the writer — unlike WriteProvenance, which is advisory caller data. None means the change did not come through a plugin. This is the field to use for loop prevention: a plugin skips events whose plugin_id is its own.

attribution: EventAttribution

Best-effort writer attribution.

Trait Implementations

impl Clone for VaultEventEnvelope

fn clone(&self) -> VaultEventEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VaultEventEnvelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VaultEventEnvelope

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for VaultEventEnvelope

impl PartialEq for VaultEventEnvelope

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for VaultEventEnvelope

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 VaultEventEnvelope