Struct AdvisorCatalogue 

pub struct AdvisorCatalogue {
    pub version: u32,
    pub capabilities: Vec<AdvisoryCapability>,
    pub advisors: Vec<AdvisorDeclaration>,
    pub peers: Option<PeerAdvisors>,
    pub forbidden_claims: Vec<String>,
}

The whole catalogue, as share/advisors.yaml declares it: the capability vocabulary, the advisors in preference order, how mesh peers become advisors, and the claims no document may assert. The default is the empty catalogue a share without the file has.

use majordomus_cli::reasoning::catalogue::AdvisorCatalogue;

let empty = AdvisorCatalogue::default();
assert!(empty.advisors.is_empty() && empty.get("anything").is_none());
let c: AdvisorCatalogue = majordomus_cli::metadata::yaml::parse_into(
    "version: 1\nforbidden_claims: [consensus guarantees correctness]\n",
).unwrap();
assert_eq!(c.forbidden_claims, ["consensus guarantees correctness"]);

Fields

version: u32

The format version.

capabilities: Vec<AdvisoryCapability>

The advisory capability vocabulary.

advisors: Vec<AdvisorDeclaration>

The advisors, in preference order.

peers: Option<PeerAdvisors>

Linked mesh runtimes as advisors, when declared.

forbidden_claims: Vec<String>

Phrases no document of the repository may assert: the claims this design refuses (“consensus guarantees correctness”), checked by reasoning.check.

Implementations

impl AdvisorCatalogue

pub fn load(share: &Path) -> Result<Self, String>

Read <share>/advisors.yaml. An absent file is an empty catalogue: a distribution that declares no advisors has none, and reasoning works without them. A file that does not parse is an error naming it.

use majordomus_cli::reasoning::catalogue::{AdvisorCatalogue, ADVISORS_FILE};

let share = tempfile::tempdir().unwrap();
assert!(AdvisorCatalogue::load(share.path()).unwrap().advisors.is_empty());
std::fs::write(share.path().join(ADVISORS_FILE), "version: one\n").unwrap();
let refused = AdvisorCatalogue::load(share.path()).unwrap_err();
assert!(refused.contains(ADVISORS_FILE));

pub fn references(share: &Path, providers: &ProviderDeclarations) -> References

The references the catalogue resolves against: the provider ids the index already read, and the model catalogue of the same share (empty when it cannot be read).

use majordomus_cli::reasoning::catalogue::AdvisorCatalogue;
use majordomus_cli::share::{ProviderDeclaration, ProviderDeclarations};

let share = tempfile::tempdir().unwrap();
let providers = ProviderDeclarations {
    providers: vec![ProviderDeclaration { id: "tool".into(), ..Default::default() }],
    ..Default::default()
};
let refs = AdvisorCatalogue::references(share.path(), &providers);
assert_eq!(refs.providers, ["tool"]);
assert!(refs.models.vendors.is_empty());

pub fn get(&self, id: &str) -> Option<&AdvisorDeclaration>

The declared advisor of an id; None for an id the catalogue does not declare, which includes every peer: id.

use majordomus_cli::reasoning::catalogue::AdvisorCatalogue;

let c: AdvisorCatalogue = majordomus_cli::metadata::yaml::parse_into(
    "version: 1\nadvisors:\n  - id: a\n    title: A\n    transport: cli\n    adapter: a-cli\n",
).unwrap();
assert_eq!(c.get("a").map(|a| a.title.as_str()), Some("A"));
assert!(c.get("peer:n1-r1").is_none());

pub fn knows_capability(&self, word: &str) -> bool

Whether a word is in the declared capability vocabulary: what reasoning.plan checks a requested capability against before it plans.

use majordomus_cli::reasoning::catalogue::AdvisorCatalogue;

let c: AdvisorCatalogue = majordomus_cli::metadata::yaml::parse_into(
    "version: 1\ncapabilities:\n  - id: code_review\n    description: x\n",
).unwrap();
assert!(c.knows_capability("code_review"));
assert!(!c.knows_capability("telepathy"));

pub fn credential_of<'a>( &self, advisor: &AdvisorDeclaration, refs: &'a References, ) -> Option<&'a str>

The credential variable whose presence says an API advisor is configured: its vendor’s, as the model catalogue declares it. Never a value, only a name. None for an advisor with no vendor, or whose vendor declares no variable.

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

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: api\n    adapter: a-api\n    vendor: acme\n    capabilities: [code_review]\n  - id: b\n    title: B\n    transport: cli\n    adapter: b-cli\n    executable: b\n    capabilities: [code_review]\n",
).unwrap();
let refs = References {
    models: majordomus_cli::metadata::yaml::parse_into("version: 1\nvendors:\n  - id: acme\n    title: Acme\n    credential_env: ACME_KEY\nmodels: []\n").unwrap(),
    ..Default::default()
};
assert_eq!(c.credential_of(c.get("a").unwrap(), &refs), Some("ACME_KEY"));
assert_eq!(c.credential_of(c.get("b").unwrap(), &refs), None);

pub fn diagnostics(&self, refs: &References) -> Vec<String>

The catalogue’s own consistency: duplicate ids, words outside the vocabulary, a reference resolving to nothing, an advisor whose presence cannot be probed. Reported, never repaired; empty is the ordinary case.

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

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: cli\n    adapter: a-cli\n    provider: nowhere\n    executable: a\n    capabilities: [code_review, telepathy]\n",
).unwrap();
let found = c.diagnostics(&References::default());
assert!(found.iter().any(|f| f.contains("provider 'nowhere'")));
assert!(found.iter().any(|f| f.contains("'telepathy'")));

Trait Implementations

impl Clone for AdvisorCatalogue

fn clone(&self) -> AdvisorCatalogue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AdvisorCatalogue

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

Formats the value using the given formatter.

impl Default for AdvisorCatalogue

fn default() -> AdvisorCatalogue

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AdvisorCatalogue

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for AdvisorCatalogue

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 Serialize for AdvisorCatalogue

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

where __S: Serializer,

Serialize this value into the given Serde serializer.