Struct Catalog 

pub struct Catalog {
    pub root: PathBuf,
    pub concerns: Concerns,
    pub modules: Vec<ModuleCrate>,
    pub skills: Pack,
}

What the tools know of an engine checkout: its concerns, the modules it builds and its skill pack.

Fields

root: PathBuf

The checkout’s folder (the one holding crates/).

concerns: Concerns

Its docs/modules.ron.

modules: Vec<ModuleCrate>

Its modules: every crate under crates/ with [package.metadata.shuyi], by name.

skills: Pack

Its skill pack, skills/ (empty in a checkout without one).

Implementations

impl Catalog

pub fn read(root: &Path) -> Result<Self, String>

The catalog of the engine checkout at root.

pub fn embedded() -> Result<Self, String>

The catalog of the engine this shuyi was built from, as it embeds it, for a game made with no checkout: its concerns, its modules by the shuyi crate’s features, one a module, with no metadata, and its skill pack.

pub fn module(&self, name: &str) -> Option<&ModuleCrate>

The module named name, with or without shuyi-.

pub fn is_module(&self, name: &str) -> bool

Whether name is a module’s crate: one the engine builds, or one a concern names as an answer’s (shuyi-net), built or not. A module’s skill is named after its crate, and a game gets it with shuyi add, not shuyi new.

Trait Implementations

impl Clone for Catalog

fn clone(&self) -> Catalog

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Catalog

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

Formats the value using the given formatter.

impl Eq for Catalog

impl PartialEq for Catalog

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Catalog