Struct StoreRef 

pub struct StoreRef { /* private fields */ }

How the config an install writes names the store.

A project install writes --auto, not a path. The MCP entry, the three settings hooks and the three git hook blocks then resolve the store when they run — $CLAUDE_PROJECT_DIR/mushroom-memory, else mushroom-memory at the root of the working tree they were run in.

The reason is git worktree. Those config files live in the repository and get committed, so an absolute path baked into them follows a new worktree across and points every hook there at the other checkout’s store: the graph then describes files that are not the ones being edited. Resolving at run time gives each working tree its own store, which is the only answer that is right in both checkouts.

--db <path> opts out and pins an absolute path; user scope always pins ~/.mushroomdb/memory, since --auto inside any checkout would resolve to that project instead.

Implementations

impl StoreRef

pub fn auto(path: impl Into<PathBuf>) -> Self

A store the config names --auto, living at path for this checkout.

pub fn pinned(path: impl Into<PathBuf>) -> Self

A store the config names by absolute path.

pub fn also_auto(self) -> Self

Mark a pinned store as the one --auto also resolves to here.

pub fn path(&self) -> &Path

Where the store is on this machine, right now.

pub fn is_auto(&self) -> bool

Whether written config resolves the store at run time.

pub fn arg(&self) -> String

The argument written into an MCP entry’s args array: --auto, or the path. Not shell-quoted — an MCP host spawns an argv, where quotes would become part of the filename.

pub fn shell_arg(&self) -> String

The same argument for a command line a shell reads, quoted where quoting is needed. --auto needs none; a path may contain a space.

Trait Implementations

impl Clone for StoreRef

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 StoreRef

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

Formats the value using the given formatter.

impl Eq for StoreRef

impl PartialEq for StoreRef

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StoreRef