Struct Registry 

pub struct Registry {
    pub harnesses: Vec<HarnessProfile>,
    pub runtimes: Vec<RuntimeProfile>,
    pub notes: Vec<String>,
}

All known profiles: the built-ins, overridden or extended by user profile dirs.

Fields

harnesses: Vec<HarnessProfile>

runtimes: Vec<RuntimeProfile>

notes: Vec<String>

Project profiles (or parts of them) that were skipped, and why.

Implementations

impl Registry

pub fn builtin() -> Registry

Only the profiles compiled into this build.

pub fn load(ctx: &Ctx) -> Result<Registry, Error>

Built-ins plus every profile found in profile_dirs.

pub fn extend_from_project_dir(&mut self, dir: &Path) -> Result<(), Error>

Add the profiles in a project’s own profile directory. They may add new ids but not replace a profile hlock already has (put an override in ~/.config/hlock/profiles), and they can’t name a program by path or probe it with anything but a version flag. What’s skipped is noted in notes.

pub fn extend_from_dir(&mut self, dir: &Path) -> Result<(), Error>

Add (or replace by id) the profiles in dir/harnesses and dir/runtimes.

pub fn load_for( ctx: &Ctx, manifest: Option<&Manifest>, ) -> Result<Registry, Error>

Built-ins, profile dirs, then the manifest’s own [harnesses.<id>] tables.

pub fn add_project_harnesses(&mut self, m: &Manifest) -> Result<(), Error>

Register a manifest’s [harnesses.<id>] tables as custom profiles. A table with framework = "<id>" inherits that framework’s packages.

pub fn harness(&self, name: &str) -> Option<&HarnessProfile>

pub fn runtime(&self, name: &str) -> Option<&RuntimeProfile>

pub fn require_harness(&self, name: &str) -> Result<&HarnessProfile, Error>

Look a harness up by id or alias, with a helpful error listing what exists.

pub fn active(&self, ctx: &Ctx) -> Option<&HarnessProfile>

The harness this process is running inside, if any.

pub fn select( &self, explicit: Option<&str>, manifest_target: Option<&str>, ctx: &Ctx, ) -> Result<Selection, Error>

Pick the harness a command should target, in precedence order: an explicit name, HLOCK_HARNESS, the manifest’s [target] harness, the harness this process runs inside, then the only installed harness.

Trait Implementations

impl Clone for Registry

fn clone(&self) -> Registry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Registry

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

Formats the value using the given formatter.

impl Default for Registry

fn default() -> Registry

Returns the “default value” for a type.