Struct Layout 

pub struct Layout { /* private fields */ }

The paths of one SCV instance.

Implementations

impl Layout

pub fn new(home: impl Into<PathBuf>) -> Self

The instance at home, selected explicitly as SCV_HOME selects one.

pub fn from_env() -> Result<Self>

The instance selected by SCV_HOME, or ~/.scv, with its home resolved: canonical when it exists, otherwise made absolute. Service unit names and delegation records hash this path, so every process of an instance must resolve it the same way.

pub fn home(&self) -> &Path

pub fn is_default(&self) -> bool

Whether this is the default instance, which SCV_HOME did not select.

pub fn service_name(&self) -> String

The instance’s systemd user unit: scv.service for the default instance, otherwise scv-<hash of the home>.service, so instances never share a unit and a release finds the unit an earlier one wrote.

pub fn config(&self) -> PathBuf

The settings file a person edits.

pub fn credentials(&self) -> PathBuf

Sign-ins SCV writes itself.

pub fn channel_credentials(&self, channel: &str) -> PathBuf

One channel’s account credentials, <account>.json each.

pub fn agents(&self) -> PathBuf

The private homes of delegated agent CLIs.

pub fn agent_home(&self, agent: &str) -> PathBuf

pub fn skills(&self) -> PathBuf

pub fn history(&self) -> PathBuf

The chat log, <channel>/<account>/<conversation>/ (see crate::history), and by default the files the owner kept.

pub fn state(&self) -> PathBuf

Runtime data SCV writes and reads back; never edited by hand.

pub fn socket(&self) -> PathBuf

pub fn delegations(&self) -> PathBuf

Records of running delegated agents.

pub fn conversations(&self) -> PathBuf

Markers of live delegated conversations, for scv agents gc.

pub fn imports(&self) -> PathBuf

What each scv agents import copied, and from where.

pub fn channel_state(&self, channel: &str) -> PathBuf

One channel’s delivery state and account locks.

pub fn media(&self) -> PathBuf

Files chat users sent, under <channel>/<account>, and copies of files the model sends back, under outbox.

pub fn outbox(&self) -> PathBuf

Copies of files the model attached, waiting to be sent to a chat.

pub fn update_plan(&self) -> PathBuf

A planned restart in progress.

pub fn last_owner(&self) -> PathBuf

The chat the account owner last wrote from.

pub fn daemon_marker(&self) -> PathBuf

Present while a daemon runs; one left behind means it did not shut down cleanly.

pub fn config_lock(&self) -> PathBuf

Serializes SCV’s own edits of config.toml.

pub fn strays(&self) -> Result<Vec<Stray>>

Entries of the home that SCV does not read, sorted by name.

Trait Implementations

impl Clone for Layout

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 Layout

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

Formats the value using the given formatter.

impl Eq for Layout

impl PartialEq for Layout

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Layout