Struct CommandResult 

pub struct CommandResult { /* private fields */ }

The result of one command, rendered as human text or as one JSON object.

exit_code always equals status.exit_code(): the constructors set it and the fields are private, so the two can never disagree.

Implementations

impl CommandResult

pub fn new(command: &str, status: CommandStatus, message: &str) -> Self

A result with the given status.

pub fn carried(command: &str, from: &Self) -> Self

from’s outcome reported as command’s: status, message and code, without from’s payload (a command passing on a failure it met).

pub fn caused_by(self, from: &Self) -> Self

The code, fixes and remedy of from, whose outcome this result reports with the same status (a feature’s run stopped by a task’s).

pub fn reworded(self, status: CommandStatus, message: &str) -> Self

The same result with another status and message: payload and next steps kept, the code kept only while the status stays the same.

pub fn with_code(self, name: &str) -> Self

Names the code (a catalog name); its fixes become the result’s unless Self::with_fix gives better ones. An unknown name is ignored, and the status’s default code applies later.

pub fn with_fix(self, fix: Vec<String>) -> Self

The fix lines, replacing the catalog’s.

pub fn with_commands(self, commands: Vec<Argvs>) -> Self

The person’s own commands among the fix lines, as the argvs the source built (each line crate::step::render of its argvs): run as these argvs, never re-read from the line.

pub fn with_command(self, argvs: Argvs) -> Self

A fix that is the person’s own command, built as argvs: its line joins the fixes, the argvs are what runs.

pub fn with_remedy(self, remedy: Option<Remedy>) -> Self

Attaches the fix speccoder can apply itself.

pub fn remedy(&self) -> Option<&Remedy>

The fix speccoder can apply itself, if it knows one.

pub fn code(&self) -> Option<&'static Entry>

The code: the one attached, else the status’s default (none for a plain ok) — no non-ok result is without one.

pub fn has_explicit_code(&self) -> bool

Whether a code was named explicitly (not the status’s default).

pub fn fix(&self) -> Vec<String>

How to resolve it: the fixes given, else the code’s own.

pub fn with_next(self, next: Vec<NextStep>) -> Self

Attaches what to do next (data.next, the human Next: block).

pub fn next(&self) -> &[NextStep]

What to do next.

pub fn with_data(self, data: CommandData) -> Self

Attaches the command’s payload.

pub fn data(&self) -> Option<&CommandData>

The command’s payload, if any.

pub fn ok(command: &str, message: &str) -> Self

A successful result.

pub fn command(&self) -> &str

The subcommand name, e.g. inspect.

pub fn status(&self) -> CommandStatus

The outcome class.

pub fn message(&self) -> &str

The single-line human-readable message.

pub fn exit_code(&self) -> ExitCode

The process exit status.

Trait Implementations

impl Clone for CommandResult

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 CommandResult

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

Formats the value using the given formatter.

impl JsonSchema for CommandResult

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl PartialEq for CommandResult

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for CommandResult

Envelope v2: next, code, fix and docs beside the typed data.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CommandResult