Struct ProgressSink 

pub struct ProgressSink { /* private fields */ }

Where a running tool reports short status lines, such as a delegated agent’s commands. Each report becomes one bounded line; the runtime forwards the pending lines to the client at most twice a second and never adds them to the model’s history. The default sink discards reports, so a tool may always report.

Implementations

impl ProgressSink

pub fn buffered() -> Self

A sink that keeps reports until the runtime takes them.

pub fn is_enabled(&self) -> bool

pub fn report(&self, text: &str)

Report one status line. Control characters and line breaks become spaces and the line is cut to MAX_PROGRESS_LINE_BYTES.

pub fn take(&self) -> Option<String>

The lines reported since the previous call, as one event text of at most MAX_PROGRESS_EVENT_BYTES, or None when nothing is pending.

Trait Implementations

impl Clone for ProgressSink

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressSink

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

Formats the value using the given formatter.

impl Default for ProgressSink

fn default() -> Self

Returns the “default value” for a type.