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.2.0.tar.gz
sha256=966fc8667c2aa9830e64950d2de74bd564a65d60e1f50cfd3dc1e99ef106dc47
sha512=6423ce04d784ba521a7f49fabdafbe036e2dd80cd08ca999fdc6767262d7f12aa4e5002d65efd4c568b343eaabf4d680191c88334d629e1ca0156084531e9e0b

doc/shakuhachi.config/SkhcConfig/Format/index.html

Module SkhcConfig.FormatSource

Operations on the .format section.

Sourcetype t

type of the format section.

Sourceval section : string

section name

Sourceval default : t

default is the section used if the format section is missing from the configuration file.

Sourceval init : filename:string -> artist_artwork:string -> album_cover:string -> music_list:string -> album_list:string -> artist_list:string -> music_remove:string -> t

init ~filename ~artist_artwork ~album_cover ~music_list ~album_list ~artist_list ~music_remove create a format section with filename, artist_artwork, album_cover, music_list, album_list, artist_list and music_remove.

  • since 0.2.0, [artist_artwork] and [album_cover] new parameters.
Sourceval of_section : Section.t -> t

of_section section parse section to create a format section. If an expected key is missing from section, the key is associated with its default value.

Sourceval to_section : t -> Section.t

to_section format serializes format into a section.

Sourceval filename : t -> string

filename format returns the formatting used for naming a music file.

Sourceval artist_artwork : t -> string

artist_cover format returns the formatting used for naming an artist's artwork.

  • since 0.2.0
Sourceval album_cover : t -> string

album_cover format returns the formatting used for naming an album's cover.

  • since 0.2.0
Sourceval music_list : t -> string

music_list format returns the formatting used when listing musics.

Sourceval artist_list : t -> string

artist format returns the formatting used when listing artists.

Sourceval album_list : t -> string

album_list format returns the formatting used when listing albums.

Sourceval music_remove : t -> string

music_remove format returns the formatting used when removing musics.