Struct AnniWorkspace 

pub struct AnniWorkspace { /* private fields */ }

Implementations

impl AnniWorkspace

pub unsafe fn new_unchecked(dot_anni: PathBuf) -> Self

Safety

If you’re sure that the directory is .anni, you can use this method to avoid unnecessary checking steps.

pub fn new() -> Result<Self, WorkspaceError>

Find AnniWorkspace from current working directory.

pub fn open<P>(path: P) -> Result<Self, WorkspaceError>

where P: AsRef<Path>,

Open a AnniWorkspace from given path.

If the path is not a valid workspace, WorkspaceError::NotAWorkspace will be returned.

pub fn find<P>(path: P) -> Result<Self, WorkspaceError>

where P: AsRef<Path>,

Find and open a AnniWorkspace from given path.

This method will try to open all parent directories until it finds a valid workspace. If workspace is not found, WorkspaceError::WorkspaceNotFound will be returned.

pub fn workspace_root(&self) -> &Path

Get root path of the workspace

pub fn repo_root(&self) -> PathBuf

Get root path of the metadata repository.

Warn

This method may be removed in the future

pub fn objects_root(&self) -> PathBuf

Get root path of internal audio files

pub fn get_album_id<P>(&self, path: P) -> Result<Uuid, WorkspaceError>

where P: AsRef<Path>,

Get album id from symlink target.

Returns WorkspaceError::NotAnAlbum if the symlink is not valid.

pub fn get_album_controlled_path( &self, album_id: &Uuid, ) -> Result<PathBuf, WorkspaceError>

Get controlled path of an album with album id.

pub fn controlled_album_path(&self, album_id: &Uuid, layer: usize) -> PathBuf

Get album path with given album_id in workspace with no extra checks.

pub fn strict_album_path( root: PathBuf, album_id: &Uuid, layer: usize, ) -> PathBuf

pub fn get_workspace_album<P>( &self, path: P, ) -> Result<WorkspaceAlbum, WorkspaceError>

where P: AsRef<Path>,

Try to get WorkspaceAlbum from given path

pub fn scan(&self) -> Result<Vec<WorkspaceAlbum>, WorkspaceError>

Scan the whole workspace and return all available albums

pub fn create_album<P>( &self, album_id: &Uuid, userland_path: P, discs: NonZeroU8, ) -> Result<(), WorkspaceError>

where P: AsRef<Path>,

Create album with given album_id and discs at given path

Creation would fail if:

• Album with given album_id already exists in workspace
• Directory at path is an album directory

pub fn to_repository_manager(&self) -> Result<RepositoryManager, WorkspaceError>

pub fn get_config(&self) -> Result<WorkspaceConfig, WorkspaceError>

impl AnniWorkspace

pub fn get_untracked_album_overview<P>( &self, album_path: P, ) -> Result<UntrackedWorkspaceAlbum, WorkspaceError>

where P: AsRef<Path>,

Take a overview of an untracked album directory.

If the path provided is not an UNTRACKED album directory, or the album is incomplete, an error will be returned.

pub fn commit<P, V>( &self, path: P, validator: Option<V>, ) -> Result<Uuid, WorkspaceError>

where P: AsRef<Path>, V: FnOnce(&UntrackedWorkspaceAlbum) -> bool,

Add album to workspace

Untracked -> Committed

pub fn import_tags<P, E>( &self, album_path: P, extractor: E, allow_duplicate: bool, ) -> Result<Uuid, WorkspaceError>

where P: AsRef<Path>, E: FnOnce(&str) -> Option<ExtractedAlbumInfo<'_>>,

Import tag from committed album.

pub fn revert<P>(&self, path: P) -> Result<(), WorkspaceError>

where P: AsRef<Path>,

pub fn apply_tags<P>(&self, album_path: P) -> Result<(), WorkspaceError>

where P: AsRef<Path>,

pub fn publish<P>( &self, album_path: P, soft: bool, ) -> Result<(), WorkspaceError>

where P: AsRef<Path>,