Skip to main content

Output

Struct Output 

Source
pub struct Output { /* private fields */ }
Expand description

Result type that handles output formatting and exit codes.

Builds Agent-First Data-compliant JSON (code/result/trace/error), redacts secrets, formats via agent_first_data, and prints protocol/log events to stdout.

Implementations§

Source§

impl Output

Source

pub fn new(format: OutputFormat) -> Self

Source

pub fn value(&self, value: Value) -> ExitCode

Emit a pre-built AFDATA value whose top-level code is already set.

Source

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

{code: “ok”, result: …} → stdout

Source

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

{code: “ok”, result: …, trace: …} → stdout

Source

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

{code: “<error_code>”, error: “msg”, hint: “…”, trace: {duration_ms: 0}} → stdout

Source

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

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

Source

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

Output error from anyhow::Error

Source

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

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

Source

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

Agent-First Data progress step → stdout {“code”: “progress”, “current”: N, “total”: M, “message”: “…”, …}

Source

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

Byte-level download progress → stdout {“code”: “download_progress”, “downloaded_bytes”: N, “total_bytes”: M}

Source

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

Non-fatal warning → stdout

Source

pub fn startup(&self, args: Value)

{code: “log”, event: “startup”, args: …, config: …, env: …} → stdout

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more