Struct Output 

pub struct Output { /* private fields */ }

The boundary a handler writes results through.

Implementations

impl Output

pub const fn new(json: bool) -> Self

The boundary for a command carrying a --json flag.

pub const fn human() -> Self

The boundary for a command whose result is the document itself — a chapter, a binding, a license — where a JSON wrapper would add nothing an agent can use.

pub const fn is_json(&self) -> bool

Whether this boundary serves the machine form.

pub fn result_line(&self, line: impl AsRef<str>)

One human result line on stdout; silent under --json, where the emitted document is the whole result.

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

A human result without a trailing newline, for byte-identical payload prints; silent under --json.

pub fn result_bytes(&self, bytes: &[u8])

A generated byte result — completions, and nothing else today — through the same pipe-safe path as every other result.

pub fn emit<T: Serialize>(&self, report: &T) -> Result<(), RkError>

The machine result: one JSON document on stdout, and nothing in human mode.

Errors

Returns RkError::Other when the report cannot serialize, which is a defect in this binary rather than anything a caller can correct.

pub fn event<T: Serialize>(&self, event: &T)

One NDJSON event line on stdout under --json, and nothing in human mode: the long-running commands’ machine stream, one complete object per line.

pub fn frame(&self, line: impl AsRef<str>)

One line of framing on stderr in human mode — step frames, the command echo, warnings — and nothing under --json, where the events carry the run.

pub fn warn(&self, line: impl AsRef<str>)

One warning line on stderr, in both modes.

pub fn child_passthrough(&self, stream: ChildStream, bytes: &[u8])

Raw child bytes to the parent’s matching stream, human mode only: never swallow a subprocess, and never corrupt a pipe either.

pub fn next(&self, lines: &[String])

The Next: block closing a human success: two to four lines naming the commands that plausibly follow, so no output is a dead end. Under --json the report’s own next field carries them.

Trait Implementations

impl Clone for Output

fn clone(&self) -> Output

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Output

impl Debug for Output

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

Formats the value using the given formatter.