package shakuhachi
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=bb7f91cc44c09f922d2a614e9e01fd0d2976840bacf839a8b99de63c6fc5b3b8
sha512=f02827db4228b017bb2ad7d64cb1c0667831ec2341e6f759266ec834e40627c2affeace143c6d5e769b3acce63f889b3cbd1a9ca4768091840e8fce1d4750f86
doc/shakuhachi.libs/Skhclibs/Collection/index.html
Module Skhclibs.CollectionSource
Operations on a shakuhachi collection.
type of a collection
open' config opens the collection with configuration provided by config.
realpath collection path returns
pathifpathis absolute (eg. starts with / on unix).- music_directory +
pathifpathis relative.
database collection returns a database handler associated with collection.
with_database collection f runs f with a database handler associated with collection. SkhcDb.Database.close is guaranteed to be called whether f completes normaly or raises an exception. with_database discards any results or exceptions of SkhcDb.Database.close.
config collection returns the configuration used when calling open'.
dir_artist collection metadata returns the directory name of where should be collected the artist's albums according to metadata. The path returned is relative to configuration's music_directory.
dir_artist_absolute collection metadata is dir_artist but returns the absolute path instead of the relative one.
dir_album collection metadata returns the directory name of where should be collected the album's songs according to metadata. The path returned is relative to configuration's music_directory. Since shakuhachi stores songs in a artist/album directory structure, this function calls dir_artist underneath.
dir_album_absolute collection metadata is dir_album but returns the absolute path instead of the relative one.