anni-workspace 0.2.2

A library to operate on anni workspace.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

use serde::Serialize;
use std::path::PathBuf;
use uuid::Uuid;

#[derive(Debug, Serialize)]
pub struct WorkspaceAlbum {
    pub album_id: Uuid,
    #[serde(flatten)]
    pub state: WorkspaceAlbumState,
}

pub struct UntrackedWorkspaceAlbum {
    pub album_id: Uuid,
    pub path: PathBuf,
    /// For album with only one disc, the disc directory is not required.
    /// Users can choose to put all tracks in the album directory.
    /// This is called `simplified` album structure.
    pub simplified: bool,
    pub discs: Vec<UntrackedWorkspaceDisc>,
}

pub struct UntrackedWorkspaceDisc {
    pub index: usize,
    pub path: PathBuf,
    pub cover: PathBuf,
    pub tracks: Vec<PathBuf>,
}

/// State of album directory in workspace
#[derive(Debug, Serialize)]
#[serde(tag = "type", content = "path")]
#[serde(rename_all = "kebab-case")]
pub enum WorkspaceAlbumState {
    // Normal states
    /// `Untracked` album directory.
    /// Controlled part of the album directory is empty.
    Untracked(PathBuf),
    /// `Committed` album directory.
    /// Controlled part of the album directory is not empty, and User part contains symlinks to the actual file.
    Committed(PathBuf),
    /// `Published` album directory.
    /// Controlled part of the album directory is not empty, and `.publish` file exists.
    Published,

    // Error states
    /// User part of an album exists, but controlled part does not exist, or the symlink is broken.
    Dangling(PathBuf),
    /// User part of an album does not exist, and controlled part is empty.
    Garbage,
}