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/Config/index.html

Module SkhcConfig.ConfigSource

Operations on a configuration file.

Sourcetype t

type of the configuration file.

Sourceval init : Collection.t -> Query.t -> Default.t -> Format.t -> Misc.t -> Plugin.t list -> t

init collection query default format misc plugins creates a new configuration with collection, query, default, format, misc and plugins.

Sourceval minimal : name:string -> database:string -> music_directory:string -> plugins_directory:string -> t

minimal ~name ~database ~music_directory ~plugins_directory creates a configuration with only mandaory values. Other values are initialized to their default values.

Sourceval plugin_conf : string -> t -> Plugin.Config.t

plugin_conf plugin_name config returns the plugin configuration plugin_name in config. Returns an empty configuration is no configuration is found for plugin_name.

Sourceval of_file : string -> (t, Err.t) result

of_file path tries to parse the file at path into a configuration.

Sourceval to_channel : out_channel -> t -> unit

to_channel oc config prints the representation of config to oc.

Sourceval collection : t -> Collection.t

collection config returns the configuration section.

Sourceval query : t -> Query.t

query config returns the query section.

Sourceval default : t -> Default.t

default config returns the default section.

Sourceval format : t -> Format.t

format config returns the format section.

Sourceval misc : t -> Misc.t

misc config returns the misc section.

Sourceval collection_name : t -> string

collection_name config returns the collection_name inside collection section.

Sourceval music_directory : t -> string

music_directory config returns the music_directory inside collection section.

Sourceval music_database : t -> string

music_database config returns the music_database inside collection section.

Sourceval plugins_directory : t -> string

plugins_directory config returns the plugins_directory inside collection section.

Sourceval query_fields : t -> SkhcQuery.Substring.t list

query_fields config returns the query_fields inside query section.

Sourceval default_title : t -> string

default_title config returns the title inside default section.

Sourceval default_album : t -> string

default_album config returns the album inside default section.

Sourceval default_artist : t -> string

default_artist config returns the artist inside default section.

Sourceval unicode_normalize_form : t -> Uunf.form

unicode_normalize_form config returns the unicode_normalize_form inside misc section.