Struct Output 

pub struct Output { /* private fields */ }

Result type that handles output formatting and exit codes.

A dedicated writer thread owns one agent_first_data::CliEmitter for the complete command lifecycle. This keeps Output usable through the thread-safe crate::EventSink trait while preserving AFDATA ordering, routing, and single-terminal-event enforcement.

Implementations

impl Output

pub fn new(format: OutputFormat) -> Self

Create a finite one-shot emitter using AFDATA’s default split routing.

pub fn with_output_to(format: OutputFormat, output_to: OutputTo) -> Self

Create an emitter using the requested AFDATA destination policy.

pub fn ok<T: Serialize>(&self, result: T) -> ExitCode

{kind: "result", result: ..., trace: {duration_ms}} → stdout.

pub fn ok_trace<T: Serialize>( &self, result: T, trace: impl Serialize, ) -> ExitCode

{kind: "result", result: ..., trace: ...} → stdout.

pub fn ok_with_code<T: Serialize>(&self, result: T, code: u8) -> ExitCode

{kind: "result", result: ...} → stdout, with a caller-chosen exit code.

For machine-checkable “is there drift” style results (e.g. hatch bond sync --check) where the outcome is a normal, well-formed result (not an error) but CI still needs a distinct non-zero exit to gate on.

pub fn error(&self, error_code: &str, message: &str) -> ExitCode

{kind: "error", error: {code, message, hint, retryable}, trace} → the configured diagnostic destination.

pub fn error_hint( &self, error_code: &str, message: &str, hint: Option<&str>, ) -> ExitCode

Like [error] but with an actionable hint for remediation.

pub fn error_from(&self, error_code: &str, err: &Error) -> ExitCode

Output error from anyhow::Error

pub fn error_hypha(&self, err: &HyphaError) -> ExitCode

Output error from crate::HyphaError (includes hint when present).

pub fn progress(&self, step: u32, total: u32, message: &str, data: Value)

Agent-First Data progress step → the configured diagnostic destination. {kind: "progress", progress: {current, total, message, ...}, trace}.

pub fn download_progress(&self, downloaded_bytes: u64, total_bytes: Option<u64>)

Byte-level protocol-v1 download progress → the configured diagnostic destination. {kind: "progress", progress: {event, downloaded_bytes, total_bytes}}.

pub fn log(&self, code: &str, message: &str)

Non-fatal informational log → the configured diagnostic destination.

pub fn log_data(&self, level: &str, code: &str, message: &str, data: Value)

Structured non-fatal log with additional tool-defined fields.

pub fn warn(&self, code: &str, message: &str)

Non-fatal warning → the configured diagnostic destination.

pub fn startup(&self, args: Value)

Emit a protocol-v1 startup log event to the diagnostic destination.

Trait Implementations

impl Drop for Output

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.