Struct Home 

pub struct Home { /* private fields */ }

The RIG_HOME layout. Every file the launcher and the agent write lives under this one root.

Implementations

impl Home

pub fn from_env() -> Self

The root from env::HOME, else ~/.rig, made absolute so the launcher, the agent and their children agree on it from any directory.

pub fn at(root: impl Into<PathBuf>) -> Self

The layout under root, made absolute: a home of its own, such as a test’s.

pub fn root(&self) -> &Path

The root itself.

pub fn plugins_toml(&self) -> PathBuf

plugins.toml, the plugin list.

pub fn plugins(&self) -> PathBuf

plugins/, where rig plugin new makes plugin crates, outside any workspace: plugins/<name> is listed in plugins.toml as path = "plugins/<name>".

pub fn settings(&self) -> PathBuf

settings.toml, the user’s settings for plugins: one table per plugin, which the agent hands to the plugin that reads it.

pub fn defaults(&self) -> PathBuf

defaults.json, the model and reasoning setting a new session starts with: the last ones chosen.

pub fn auth(&self) -> PathBuf

auth/, where /login keeps each subscription credential, as <provider>.json.

pub fn project(&self) -> PathBuf

The generated agent project.

pub fn build_log(&self) -> PathBuf

The whole output of the last build, the launcher’s and cargo’s, rewritten by every build: the one before each start and rig build, which /reload runs. Its last line says how the build ended.

pub fn target(&self) -> PathBuf

Cargo’s target directory for the agent project.

pub fn bin(&self) -> PathBuf

The directory of the builds and the build lock.

pub fn good(&self) -> PathBuf

The last build that started up.

pub fn staged(&self) -> PathBuf

The build rig build staged for whichever launcher starts next.

pub fn described(&self, stamp: &str) -> PathBuf

The AgentDescription report of the build whose stamp is stamp (its modification time in nanoseconds and its length, as "{mtime} {len}"), one per build, which every copy of the build shares.

pub fn rejected(&self) -> PathBuf

The stamp of the last build that stopped before it was ready.

pub fn build_lock(&self) -> PathBuf

The lock every launcher on this root takes to generate, build and stage the agent.

pub fn staged_for(&self, session: &SessionId) -> PathBuf

The build staged for the launcher of session alone.

pub fn trial_for(&self, session: &SessionId) -> PathBuf

The build the launcher of session runs until it is ready.

pub fn owner_of(name: &str) -> Option<SessionId>

The session whose launcher owns a file of Home::bin named name: a staged-<session> or trial-<session>.

pub fn data(&self) -> PathBuf

data/, where plugins keep files across sessions and projects.

pub fn projects(&self) -> PathBuf

projects/, where plugins keep files per project, one directory for each project the agent worked in.

pub fn runs(&self) -> PathBuf

The directory holding every running launcher’s RunDir.

pub fn run(&self, launcher: u32) -> RunDir

The run directory of the launcher with the process id launcher.

pub fn sessions(&self) -> PathBuf

The directory holding every session’s directory.

pub fn session(&self, session: &SessionId) -> SessionDir

The directory of session.

pub fn new_session(&self) -> Result<(SessionId, SessionDir)>

A new session, its directory created: a SessionId::generated id, or, when a session of this home has that one, the first free one after it, such as 1700000000-42-1.

Errors

When the directory cannot be created.

pub fn saved_sessions(&self) -> Vec<(SessionId, SessionDir)>

Every saved session of this home (not one being deleted), in no order, with its directory: what every listing and Self::find read.

pub fn find(&self, name_or_id: &str) -> Result<SessionId, String>

The saved session name_or_id names: the one with that id when it parses as one and is saved, else the only saved session with that SessionDir::name.

Errors

When no saved session has that id or name, or several have that name: the error lists their ids.

Trait Implementations

impl Clone for Home

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Home

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

Formats the value using the given formatter.