Skip to main content

StorageLayout

Struct StorageLayout 

Source
pub struct StorageLayout { /* private fields */ }
Expand description

Computes all Synwire storage paths for a given product name.

§Configuration hierarchy

  1. SYNWIRE_DATA_DIR / SYNWIRE_CACHE_DIR environment variables
  2. Programmatic override via StorageLayout::with_root
  3. Project-local .<product>/config.json
  4. Platform default (directories::BaseDirs)

Implementations§

Source§

impl StorageLayout

Source

pub fn new(product_name: impl Into<String>) -> Result<Self, StorageError>

Create a new layout for the given product name, respecting environment variables and platform defaults.

§Errors

Returns StorageError::NotWritable if the platform provides no usable base directories.

Source

pub fn with_root( root: impl AsRef<Path>, product_name: impl Into<String>, ) -> Self

Create a layout rooted at a custom base directory (for testing or explicit overrides). Data is stored under <root>/data/<product> and caches under <root>/cache/<product>.

Source

pub fn with_config(self, config: &StorageConfig) -> Self

Apply a StorageConfig override on top of this layout.

Source

pub fn data_home(&self) -> &Path

Root durable data directory for this product.

Source

pub fn cache_home(&self) -> &Path

Root cache directory for this product.

Source

pub fn product_name(&self) -> &str

Product name.

Source

pub fn session_db(&self, session_id: &str) -> PathBuf

SQLite checkpoint database for a given session ID.

Source

pub fn experience_db(&self, worktree: &WorktreeId) -> PathBuf

Per-worktree experience pool database.

Source

pub fn skills_dir(&self) -> PathBuf

Global agent skills directory.

Source

pub fn logs_dir(&self) -> PathBuf

Rotating log files directory.

Source

pub fn daemon_pid_file(&self) -> PathBuf

Daemon PID file path.

Source

pub fn daemon_socket(&self) -> PathBuf

Daemon Unix domain socket path.

Source

pub fn global_experience_db(&self) -> PathBuf

Global cross-project experience database.

Source

pub fn global_dependency_db(&self) -> PathBuf

Global cross-project dependency index database.

Source

pub fn global_registry(&self) -> PathBuf

Global project registry JSON file.

Source

pub fn global_config(&self) -> PathBuf

Global product config JSON file.

Source

pub fn index_cache(&self, worktree: &WorktreeId) -> PathBuf

Vector + BM25 index cache directory for a worktree.

Source

pub fn graph_dir(&self, worktree: &WorktreeId) -> PathBuf

Code dependency graph directory for a worktree.

Source

pub fn communities_dir(&self, worktree: &WorktreeId) -> PathBuf

Community detection state directory for a worktree.

Source

pub fn lsp_cache(&self, worktree: &WorktreeId) -> PathBuf

LSP server cache directory for a worktree.

Source

pub fn models_cache(&self) -> PathBuf

Embedding model download cache.

Source

pub fn repos_cache(&self) -> PathBuf

Root directory for cloned repositories.

Source

pub fn repo_cache(&self, owner: &str, repo: &str) -> PathBuf

Directory for a specific cloned repository.

Source

pub fn repo_gc(&self, max_age_days: u64) -> Result<Vec<PathBuf>, StorageError>

Remove cached repositories not accessed within max_age_days.

Returns the list of directories removed. Skips repositories that are currently mounted (not implemented in v0.1).

§Errors

Returns StorageError::Io if a directory entry cannot be read or removed.

Source

pub fn project_skills_dirname(&self) -> &str

Name of the project-local skills directory (e.g., .synwire).

Source

pub fn ensure_dir(&self, path: &Path) -> Result<(), StorageError>

Ensure the given directory exists, creating it (and all parents) as needed. Sets permissions to 0o700 on Unix.

§Errors

Returns StorageError::Io if the directory cannot be created.

Source

pub fn load_project_config( &self, project_root: &Path, ) -> Result<Option<StorageConfig>, StorageError>

Load a per-project config from <project_root>/.<product>/config.json.

Returns Ok(None) if the file does not exist.

§Errors

Returns StorageError::InvalidConfig if the file exists but is not valid JSON.

Trait Implementations§

Source§

impl Clone for StorageLayout

Source§

fn clone(&self) -> StorageLayout

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StorageLayout

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more