Struct AdvisorState 

pub struct AdvisorState {

    pub id: String,
    pub title: String,
    pub transport: AdvisorTransport,
    pub adapter: String,
    pub capabilities: Vec<String>,
    pub model: Option<String>,
    pub executable: Option<String>,
    pub credential: Option<String>,
    pub status: AdvisorStatus,
    pub reason: String,
    pub probe: String,
    pub recovering: bool,
    pub circuit: Option<AdvisorCircuit>,
}

One advisor as it stands now: what the catalogue declares of it, its status, the one machine word saying why, and what was probed. The row reasoning.advisors reports and the policy plans over.

use majordomus_cli::reasoning::availability::*;
use majordomus_cli::reasoning::catalogue::{AdvisorCatalogue, References};

struct Nothing;
impl Presence for Nothing {
    fn executable(&self, _: &str) -> bool { false }
    fn variable(&self, _: &str) -> bool { false }
}
let c: AdvisorCatalogue = majordomus_cli::metadata::yaml::parse_into(
    "version: 1\ncapabilities:\n  - id: code_review\n    description: x\nadvisors:\n  - id: a\n    title: A\n    transport: local_runtime\n    adapter: a-rt\n    executable: rt\n    capabilities: [code_review]\n",
).unwrap();
let refs = References::default();
let state: AdvisorState = derive_availability(&c, &Inputs {
    refs: &refs, presence: &Nothing, mode: ReasoningMode::Standard, disabled: &[],
    history: &[], peers: &[], now: 0, cooldown: None,
})
.remove(0);
assert_eq!((state.id.as_str(), state.status), ("a", AdvisorStatus::Unavailable));
assert_eq!(state.probe, "executable rt on PATH");
assert!(state.circuit.is_none() && !state.recovering);

Fields

id: String

The advisor id (a peer is peer:<runtime>).

title: String

The human name.

transport: AdvisorTransport

How it is reached.

adapter: String

The adapter that speaks to it.

capabilities: Vec<String>

The advisory capabilities it offers.

model: Option<String>

The model it asks, when the catalogue names one: what its adapter sends.

executable: Option<String>

The executable its adapter runs, when it runs one.

credential: Option<String>

The name of the credential variable its adapter reads — a name, never a value.

status: AdvisorStatus

Its standing.

reason: String

Why, as one machine word: present, executable_not_found, credential_absent, mode_ci, mode_offline, disabled_by_configuration, consecutive_failures, rate_limited, authentication_failed, peer_linked.

probe: String

What was observed, for a person: which executable, which variable (never a value).

recovering: bool

Available again after an open circuit’s cooldown: the next consultation is its test.

circuit: Option<AdvisorCircuit>

The open circuit, when there is one.

Trait Implementations

impl Clone for AdvisorState

fn clone(&self) -> AdvisorState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AdvisorState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AdvisorState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for AdvisorState

impl JsonSchema for AdvisorState

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 PartialEq for AdvisorState

fn eq(&self, other: &AdvisorState) -> 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 Serialize for AdvisorState

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 AdvisorState