Struct PatchEvent 

pub struct PatchEvent {
    pub action: PatchAction,
    pub purl: Option<String>,
    pub uuid: Option<String>,
    pub old_uuid: Option<String>,
    pub files: Vec<PatchEventFile>,
    pub reason: Option<String>,
    pub error_code: Option<String>,
    pub error: Option<String>,
    pub details: Option<Value>,
}

One observable thing that happened during a run.

Fields

action: PatchAction

What happened. See PatchAction for the full vocabulary.

purl: Option<String>

The package PURL this event is about, when applicable. Always set for patch-level events; omitted for artifact-level events that don’t trace to a specific package.

uuid: Option<String>

The patch UUID, when known. Always set when the event is about a specific patch record; omitted for cleanup events that affect many patches at once.

old_uuid: Option<String>

The UUID this patch replaced. Set only on Updated events so a consumer can diff a manifest update — the new UUID lives in uuid, the one it overwrote here. Omitted for every other action.

files: Vec<PatchEventFile>

Files touched by an Applied / Verified / Removed event. Empty for actions that don’t operate on files (e.g. Downloaded).

reason: Option<String>

Human-readable explanation for Skipped or Failed events. Machine consumers should prefer error_code for routing decisions.

error_code: Option<String>

Stable, lowercase, snake_case reason tag for programmatic routing. Examples: already_patched, package_not_installed, hash_mismatch, no_local_source, paid_required.

error: Option<String>

Underlying error message for Failed events.

details: Option<Value>

Command-specific additional fields. Consumers MUST NOT depend on the shape of this object — different subcommands attach different keys here. Used today for list (vulnerabilities, license, tier, description) and scan (discovered metadata not covered by the other event fields).

Implementations

impl PatchEvent

pub fn new(action: PatchAction, purl: impl Into<String>) -> Self

Construct an event with only the required action and purl. Use the with_* builders to attach optional fields.

pub fn artifact(action: PatchAction) -> Self

Construct an event that isn’t scoped to a single package (e.g. a repair run that swept orphan blobs).

pub fn with_uuid(self, uuid: impl Into<String>) -> Self

pub fn with_old_uuid(self, old_uuid: impl Into<String>) -> Self

Attach the UUID this event’s patch replaced. Use on Updated events so consumers can diff against the prior manifest entry; serializes as oldUuid.

pub fn with_files(self, files: Vec<PatchEventFile>) -> Self

pub fn with_reason( self, code: impl Into<String>, message: impl Into<String>, ) -> Self

pub fn with_error( self, code: impl Into<String>, message: impl Into<String>, ) -> Self

pub fn with_details(self, details: Value) -> Self

Attach command-specific extra fields. See PatchEvent::details for the contract — consumers should not depend on the shape.

Trait Implementations

impl Clone for PatchEvent

fn clone(&self) -> PatchEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PatchEvent

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

Formats the value using the given formatter.

impl Serialize for PatchEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.