Collection (p.shakuhachi.0.3.0.doc.shakuhachi.config.SkhcConfig.Collection)

Sourcetype t

type of the collection section

Sourceval section : string

section name

val init : 
  name:string ->
  database:string ->
  music_directory:string ->
  plugins_directory:string ->
  t

init ~name ~database ~music_directory ~plugins_directory creates a collection section with name, database, music_directory, plugins_directory.

Sourceval of_section : Section.t -> (t, Err.t) result

of_section section tries to parse section to create a collection section. of_section fails if one of the expected key is missing.

Sourceval to_section : t -> Section.t

to_section collection serializes collection into a section.

Sourceval name : t -> string

name collection returns the collection's name.

Sourceval database : t -> string

database collection returns the path to the database.

Sourceval music_directory : t -> string

music_directory collection returns the path to the music_directory.

Sourceval plugins_directory : t -> string

plugins_directory collection returns the path to the plugins_directory.