package shakuhachi

  1. Overview
  2. Docs
A music collection manager

Install 

dune-project
 Dependency

codeberg.org Readme Changelog Edit opam file Versions (5)

Authors

  1. E
    EruEri <nayinayu@mailo.com>

Maintainers

  1. E
    EruEri <nayinayu@mailo.com>

Sources

0.3.2.tar.gz
sha256=c72807d303de137441b643fec1c7630c930ebc792b576783c7961b237c2114db
sha512=770f878bbdac8033d90e904ce8e9c84fc75331c7ff9b35e2204fafe3746f432f2664296dac91942a788b82a2da07478d91b76ed85cd880758d2def8a55144840

doc/shakuhachi.libs/Skhclibs/Collection/index.html

Module Skhclibs.CollectionSource

Operations on a shakuhachi collection.

Sourcetype t

type of a collection

open' config opens the collection with configuration provided by config.

Sourceval realpath : t -> string -> string

realpath collection path returns

  • path if path is absolute (eg. starts with / on unix).
  • music_directory + path if path is relative.
Sourceval database : ?mode:[ `NO_CREATE | `READONLY ] -> ?uri:bool -> ?memory:bool -> ?mutex:[ `FULL | `NO ] -> ?cache:[ `PRIVATE | `SHARED ] -> ?vfs:string -> t -> SkhcDb.Database.t

database collection returns a database handler associated with collection.

see Sqlite3.db_open for details of all optional arguments.

  • before 0.3.0,

    no mode, uri, memory, mutex, cache, vfs optional arguments.

Sourceval with_database : ?mode:[ `NO_CREATE | `READONLY ] -> ?uri:bool -> ?memory:bool -> ?mutex:[ `FULL | `NO ] -> ?cache:[ `PRIVATE | `SHARED ] -> ?vfs:string -> t -> (SkhcDb.Database.t -> 'a) -> 'a

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.

see Sqlite3.db_open for details of all optional arguments.

  • before 0.3.0,

    no mode, uri, memory, mutex, cache, vfs optional arguments.

config collection returns the configuration used when calling open'.

Sourceval dir_artist : t -> SkhcMetadata.Metadata.t -> string

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.

Sourceval dir_artist_absolute : t -> SkhcMetadata.Metadata.t -> string

dir_artist_absolute collection metadata is dir_artist but returns the absolute path instead of the relative one.

Sourceval dir_album : t -> SkhcMetadata.Metadata.t -> string

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.

Sourceval dir_album_absolute : t -> SkhcMetadata.Metadata.t -> string

dir_album_absolute collection metadata is dir_album but returns the absolute path instead of the relative one.

Sourcemodule Album : sig ... end

Operations on albums

Sourcemodule Artist : sig ... end

Operations on artists

Sourcemodule Music : sig ... end

Operations on musics

Sourcemodule Playlist : sig ... end

Operations on playlists