Struct VolumeStore 

pub struct VolumeStore { /* private fields */ }

Persistent store for volume configurations.

Implementations

impl VolumeStore

pub fn new(path: impl Into<PathBuf>, volumes_dir: impl Into<PathBuf>) -> Self

Create a new store at the given path.

pub fn default_path() -> Result<Self>

Create a store at the default location (~/.a3s/volumes.json).

pub fn load(&self) -> Result<HashMap<String, VolumeConfig>>

Load all volumes from disk.

pub fn save(&self, volumes: &HashMap<String, VolumeConfig>) -> Result<()>

Save all volumes to disk (atomic write).

pub fn get(&self, name: &str) -> Result<Option<VolumeConfig>>

Get a single volume by name.

pub fn create(&self, config: VolumeConfig) -> Result<VolumeConfig>

Create a new named volume. Returns the host mount point path.

Creates the volume data directory under ~/.a3s/volumes/<name>/. Errors if the name already exists (use Self::get_or_create for the idempotent auto-create on the run -v name:/path path).

pub fn get_or_create(&self, config: VolumeConfig) -> Result<VolumeConfig>

Return the existing volume, or create it if absent — atomic under the cross-process lock. Two concurrent first-time run -v name:/path then share one volume instead of one racing to an “already exists” error.

pub fn remove(&self, name: &str, force: bool) -> Result<VolumeConfig>

Remove a volume by name. Returns error if in use.

pub fn list(&self) -> Result<Vec<VolumeConfig>>

List all volumes.

pub fn update(&self, config: &VolumeConfig) -> Result<()>

Replace a volume’s config wholesale under the cross-process lock.

For attach/detach prefer Self::modify: a get → mutate → update reads outside the lock and would lose a concurrent update made between the two calls.

pub fn modify<F>(&self, name: &str, f: F) -> Result<bool>

where F: FnOnce(&mut VolumeConfig),

Atomically mutate one volume’s config under the cross-process lock.

Re-reads the current entry inside the lock so concurrent attach/detach accumulate correctly — the canonical fix for the split get → mutate → update race that could drop a volume’s in_use_by entry. Returns false if the volume does not exist.

pub fn prune(&self) -> Result<Vec<String>>

Remove all volumes that are not in use. Returns names of removed volumes.

pub fn volume_dir(&self, name: &str) -> PathBuf

Get the volume data directory for a named volume.

pub fn path(&self) -> &Path

Get the store file path.

Trait Implementations

impl Debug for VolumeStore

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

Formats the value using the given formatter.

impl VolumeStoreBackend for VolumeStore

fn get(&self, name: &str) -> Result<Option<VolumeConfig>>

Get a volume by name.

fn create(&self, config: VolumeConfig) -> Result<VolumeConfig>

Create a new named volume. Returns the created config with mount point set.

fn remove(&self, name: &str, force: bool) -> Result<VolumeConfig>

Remove a volume by name. If force is false, returns error if in use.

fn list(&self) -> Result<Vec<VolumeConfig>>

List all volumes.

fn update(&self, config: &VolumeConfig) -> Result<()>

Update a volume in-place (e.g., after attach/detach).

fn prune(&self) -> Result<Vec<String>>

Remove all unused volumes. Returns names of removed volumes.