Enum Event 

pub enum Event {
    Log {
        level: LogLevel,
        msg: String,
    },
    Progress {
        done: u64,
        total: Option<u64>,
        msg: String,
    },
    Note {
        path: String,
        action: NoteAction,
    },
    Result {
        ok: bool,
        summary: Option<Value>,
        data: Option<Value>,
        no_index: bool,
    },
}

One newline-delimited JSON record on a plugin’s stdout. Externally tagged on type.

Streaming = emit Progress/Note as work happens, then a final Result. Batch = emit only the final Result. Same schema; the plugin chooses.

Variants

Log

A structured log line core may render uniformly (human-readable logs also go to stderr).

Fields

level: LogLevel

msg: String

Progress

Progress for a uniform progress indicator. total omitted ⇒ indeterminate.

Fields

done: u64

total: Option<u64>

msg: String

Note

A vault note the plugin created/changed. path is relative to the vault root. Core collects these and runs one incremental index after the plugin exits cleanly.

Fields

path: String

action: NoteAction

Result

Terminal event. summary/data are plugin-defined JSON. no_index: true tells core to skip the post-run index pass (e.g. a --dry-run).

Fields

ok: bool

summary: Option<Value>

data: Option<Value>

no_index: bool

Implementations

impl Event

pub fn parse_line(line: &str) -> Option<Event>

Parse one stdout line as an Event. Returns None when the line is not a known event — the caller (core) then echoes that line verbatim. Blank/whitespace lines are None.

pub fn to_line(&self) -> String

Serialize to a single NDJSON line (no trailing newline).

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Event

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Event

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

where __S: Serializer,

Serialize this value into the given Serde serializer.