Skip to main content

StdoutReporter

Struct StdoutReporter 

Source
pub struct StdoutReporter<W> { /* private fields */ }
Expand description

Human-readable reporter that writes structured log lines to a Write sink.

Each AgentEvent is printed as a bracketed tag followed by key fields, for example [turn] started session=abc turn=1. Turn results include indented item and part summaries so the operator can follow the conversation at a glance.

I/O errors are collected internally; call take_errors after the loop to inspect them.

§Example

use agentkit_reporting::StdoutReporter;

// Print events to stderr, hiding usage lines.
let reporter = StdoutReporter::new(std::io::stderr())
    .with_usage(false);

Implementations§

Source§

impl<W> StdoutReporter<W>
where W: Write,

Source

pub fn new(writer: W) -> Self

Creates a new StdoutReporter that writes to the given writer.

Usage lines are shown by default. Disable them with with_usage(false).

§Arguments
  • writer - Any Write implementation (typically std::io::stdout() or std::io::stderr()).
Source

pub fn with_usage(self, show_usage: bool) -> Self

Controls whether [usage] lines are printed (builder pattern).

Defaults to true. Set to false to reduce output noise when you are already tracking usage through a UsageReporter.

Source

pub fn writer(&self) -> &W

Returns a shared reference to the underlying writer.

Source

pub fn take_errors(&mut self) -> Vec<ReportError>

Drains and returns all errors accumulated during event handling.

Subsequent calls return an empty Vec until new errors occur.

Trait Implementations§

Source§

impl<W> LoopObserver for StdoutReporter<W>
where W: Write + Send,

Source§

fn handle_event(&mut self, event: AgentEvent)

Called synchronously for every AgentEvent emitted by the loop driver.

Auto Trait Implementations§

§

impl<W> Freeze for StdoutReporter<W>
where W: Freeze,

§

impl<W> !RefUnwindSafe for StdoutReporter<W>

§

impl<W> Send for StdoutReporter<W>
where W: Send,

§

impl<W> Sync for StdoutReporter<W>
where W: Sync,

§

impl<W> Unpin for StdoutReporter<W>
where W: Unpin,

§

impl<W> UnsafeUnpin for StdoutReporter<W>
where W: UnsafeUnpin,

§

impl<W> !UnwindSafe for StdoutReporter<W>

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.