Struct Answer 

pub struct Answer<T> {
    pub contract: u32,
    pub op: Op,
    pub ok: bool,
    pub result: Option<T>,
    pub error: Option<String>,
    pub code: Option<String>,
    pub help: Option<String>,
    pub limits: Vec<String>,
}

What an operation answers.

Fields

contract: u32

The contract’s version (VERSION).

op: Op

The operation.

ok: bool

Whether it passed: nothing found by a check, runs that agree, a game made, a toolchain complete. False too when it could not run.

result: Option<T>

What it found or made; absent when it could not run.

error: Option<String>

Why it could not run, if it could not.

code: Option<String>

The problem code of its error (SH1002), or of its failure when it ran and failed on the setup (doctor); shuyi explain <code> prints its page.

help: Option<String>

How to fix it, with the code.

limits: Vec<String>

What it could not determine, in plain words.

Implementations

impl<T> Answer<T>

pub fn new(op: Op, ok: bool, result: T, limits: Vec<String>) -> Self

Operation op’s result, passed if ok, with limits.

pub fn failed(op: Op, code: Code, error: impl Into<String>) -> Self

Operation op, which could not run because of error, a problem of code code, with its row’s help.

pub fn with_code(self, code: Code) -> Self

This answer with problem code code and its row’s help: for an answer that ran and failed on the setup.

pub fn with_help(self, help: impl Into<String>) -> Self

This answer with help instead of its code’s: a usage, or what to fix first.

pub fn limited(self, limit: impl Into<String>) -> Self

This answer with limit added to its limits.

pub fn exit_code(&self) -> u8

The process exit code for it: 0 if it passed, else its code’s class’s (codes::Class::exit_code), 1 with no code.

pub fn to_json(&self) -> String

where T: Serialize,

The answer as JSON, one document, pretty-printed.

pub fn to_text(&self, text: impl FnOnce(&T) -> String) -> String

The answer for people: the result as text writes it, then the error with its code and help (codes::said), then the limits.

Trait Implementations

impl<T: Clone> Clone for Answer<T>

fn clone(&self) -> Answer<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Answer<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Answer<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> JsonSchema for Answer<T>

where T: JsonSchema,

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

The name of the generated JSON Schema.

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

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

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.

impl<T: PartialEq> PartialEq for Answer<T>

fn eq(&self, other: &Answer<T>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T> Serialize for Answer<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: PartialEq> StructuralPartialEq for Answer<T>