Enum ConsultationStatus 

pub enum ConsultationStatus {
    Completed,
    Timeout,
    RateLimited,
    AuthFailed,
    Malformed,
    Empty,
    Unavailable,
    Cancelled,
    Error,
}

How a consultation ended, as the adapter classified it.

Only a completed consultation carries advice and counts as review; every other status is a degradation that is recorded so the state can report it, never hidden. The wire form is the snake_case word that ConsultationStatus::as_str returns.

use majordomus_cli::reasoning::record::ConsultationStatus;

let s: ConsultationStatus = serde_json::from_str("\"rate_limited\"").unwrap();
assert_eq!(s, ConsultationStatus::RateLimited);
assert!(!s.is_transient());
assert!(ConsultationStatus::Timeout.is_transient());

Variants

Completed

An answer was received and normalised.

Timeout

No answer within the time allowed.

RateLimited

The advisor refused for rate.

AuthFailed

The credential was refused.

Malformed

An answer arrived that could not be normalised.

Empty

An answer arrived with nothing in it.

Unavailable

The advisor could not be reached: not running, not answering, gone.

Cancelled

The session withdrew the request.

Error

Anything else the adapter could not classify.

Implementations

impl ConsultationStatus

pub fn is_transient(self) -> bool

A failure that says the advisor may not be askable right now.

A timeout, an unreachable advisor and an unclassified error are transient: they count towards opening the advisor’s circuit. A refused credential, a rate limit or a malformed answer say something more specific and are not.

use majordomus_cli::reasoning::record::ConsultationStatus;

assert!(ConsultationStatus::Unavailable.is_transient());
assert!(!ConsultationStatus::Completed.is_transient());
assert!(!ConsultationStatus::AuthFailed.is_transient());

pub fn as_str(self) -> &'static str

The status as the snake_case word the records and refusals spell it with.

It is the same word serde writes, so a refusal message and a stored record never disagree about how a status is named.

use majordomus_cli::reasoning::record::ConsultationStatus;

let s = ConsultationStatus::AuthFailed;
assert_eq!(s.as_str(), "auth_failed");
assert_eq!(serde_json::to_string(&s).unwrap(), format!("\"{}\"", s.as_str()));

Trait Implementations

impl Clone for ConsultationStatus

fn clone(&self) -> ConsultationStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ConsultationStatus

impl Debug for ConsultationStatus

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConsultationStatus

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ConsultationStatus

impl Hash for ConsultationStatus

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for ConsultationStatus

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 Ord for ConsultationStatus

fn cmp(&self, other: &ConsultationStatus) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ConsultationStatus

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ConsultationStatus

fn partial_cmp(&self, other: &ConsultationStatus) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ConsultationStatus

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 ConsultationStatus