Enum ResponseBody 

pub enum ResponseBody {
    Welcome {
        version: u32,
        verbs: Vec<String>,
        session: String,
    },
    Done {
        outcome: String,
        points: Vec<ResolvedPoint>,
        detail: Option<String>,
        elapsed_ms: u64,
    },
    Located {
        moved: Vec<String>,
        missing: Vec<String>,
    },
    Closed,
    Error {
        detail: String,
    },
}

Variants

Welcome

Answer to hello: what this build speaks and what it can do.

Fields

version: u32

verbs: Vec<String>

Step names this build understands, so a client can degrade gracefully instead of guessing.

session: String

Done

A step ran. outcome is the same vocabulary a run report uses: verified · executed · failed.

A step that ran and failed honestly is a done with outcome: "failed" and a detail; a request that could not be understood or resolved is an error. That is the same line the exit codes draw between 1 and 2.

Fields

outcome: String

points: Vec<ResolvedPoint>

detail: Option<String>

Why it failed, in words — including the evidence a timeout gathered. Absent when nothing went wrong.

elapsed_ms: u64

Located

Regions were re-located.

Fields

moved: Vec<String>

Labels whose current position differs from the session.

missing: Vec<String>

Labels that could not be found unambiguously — acting on these would be acting blind.

Closed

Acknowledgment of bye. The last line before stdout closes.

Error

The request could not be honored. detail is written for a human to read and act on, not for a stack trace.

Fields

detail: String

Trait Implementations

impl Clone for ResponseBody

fn clone(&self) -> ResponseBody

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseBody

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResponseBody

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ResponseBody

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ResponseBody

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ResponseBody