Struct ModelCatalogue 

pub struct ModelCatalogue {
    pub version: u32,
    pub vendors: Vec<Vendor>,
    pub models: Vec<ModelEntry>,
}

The whole catalogue, as share/models.yaml declares it.

Fields

version: u32

The format version.

vendors: Vec<Vendor>

The vendors, in declaration order.

models: Vec<ModelEntry>

The models, in declaration order — which is also routing’s preference order: the first satisfying model wins, and “why this one” is “it came first among those that qualify”, an answer a person can verify by reading the file.

Implementations

impl ModelCatalogue

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

Load the catalogue from a share directory. No file is an empty catalogue — a distribution that declares no models has none, which is an answer; a file that does not parse is an error naming it.

pub fn resolve(&self, name: &str) -> Option<&ModelEntry>

The entry a canonical id or an alias resolves to.

pub fn vendor_of(&self, entry: &ModelEntry) -> Option<&Vendor>

The declared vendor of an entry.

pub fn diagnostics(&self) -> Vec<String>

The catalogue’s own consistency: duplicate ids or aliases, and a model naming a vendor the catalogue does not declare. Reported, never repaired.

Trait Implementations

impl Clone for ModelCatalogue

fn clone(&self) -> ModelCatalogue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelCatalogue

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

Formats the value using the given formatter.

impl Default for ModelCatalogue

fn default() -> ModelCatalogue

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ModelCatalogue

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ModelCatalogue

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 ModelCatalogue

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

where __S: Serializer,

Serialize this value into the given Serde serializer.