Struct WriteProvenance 

#[non_exhaustive]
pub struct WriteProvenance {
    pub source: String,
    pub correlation_id: Option<String>,
    pub note: Option<String>,
}

Provenance supplied by a writer for best-effort event correlation.

Every field is caller-supplied and therefore unverified. For trustworthy loop prevention use VaultEventEnvelope::plugin_id, which the host stamps.

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.

source: String

Stable caller-selected source, such as daily-review-agent.

correlation_id: Option<String>

Optional identifier connecting related operations.

note: Option<String>

Optional human-readable reason.

Implementations

impl WriteProvenance

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

Construct provenance for source.

pub fn with_correlation_id(self, correlation_id: impl Into<String>) -> Self

Link this write to related operations.

pub fn with_note(self, note: impl Into<String>) -> Self

Explain why the write happened.

Trait Implementations

impl Clone for WriteProvenance

fn clone(&self) -> WriteProvenance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WriteProvenance

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WriteProvenance

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for WriteProvenance

impl PartialEq for WriteProvenance

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for WriteProvenance

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 WriteProvenance