Struct hermes_cli_framework::output::Output

pub struct Output {
    pub status: Status,
    pub result: Result,
}

A CLI output with support for JSON serialization. The only mandatory field is the status, which typically signals a success (UNIX process return code 0) or an error (code 1). An optional result can be added to an output.

Fields

status: Status

The return status

result: Result

The result of a command, such as the output from a query or transaction.

Implementations

impl Output

pub fn new(status: Status) -> Self

Constructs a new Output with the provided status and an empty result.

pub fn with_success() -> Self

Constructor that returns a new Output having a Success status and empty result.

pub fn with_error() -> Self

Constructor that returns a new Output having an Error status and empty result.

pub fn with_result<R>(self, result: R) -> Self

where R: Serialize + Debug + Send + Sync + 'static,

Builder-style method for attaching a result to an output object.

pub fn with_msg(self, msg: impl ToString) -> Self

Builder-style method for attaching a plain text message to an output object.

pub fn success<R>(result: R) -> Self

where R: Serialize + Debug + Send + Sync + 'static,

Quick-access constructor for an output signalling a success status and tagged with the input result.

pub fn error(msg: impl ToString) -> Self

Quick-access constructor for an output message signalling a error status.

pub fn success_msg(msg: impl ToString) -> Self

Quick-access constructor for an output signalling a success status and tagged with the input result.

pub fn print(self)

pub fn exit(self) -> !

Exits from the process with the current output. Convenience wrapper over exit_with.

pub fn into_json(self) -> Value

Convert this output value to a JSON value