package shakuhachi
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=966fc8667c2aa9830e64950d2de74bd564a65d60e1f50cfd3dc1e99ef106dc47
sha512=6423ce04d784ba521a7f49fabdafbe036e2dd80cd08ca999fdc6767262d7f12aa4e5002d65efd4c568b343eaabf4d680191c88334d629e1ca0156084531e9e0b
doc/shakuhachi.libs/Skhclibs/Format/index.html
Module Skhclibs.FormatSource
Operations on formatting. This module offers functions for substituing keys inside format string.
val filename :
extension:string ->
SkhcConfig.Config.t ->
SkhcMetadata.Metadata.t ->
string ->
stringfilename ~extension config metadata format substitutes keys inside format by mapping keys with information inside metadata. extension maps to the filename's extension. The returned strings is guaranted to not contain any '/', '\\' or 0x00 character.
val music :
SkhcDb.MusicFile.t ->
SkhcDb.Album.t ->
(string * SkhcDb.Roles.t) SkhcDb.Ids.Map.t ->
SkhcMetadata.Metadata.Values.t SkhcMetadata.Metadata.Properties.t ->
string ->
stringmusic music album roles properties format substitutes keys inside format by mapping keys with information inside music, album, roles and properties.
val album :
safe:bool ->
extension:string option ->
SkhcDb.Album.t ->
SkhcDb.Album.Stats.t ->
(string * SkhcDb.Roles.t) SkhcDb.Ids.Map.t ->
string ->
stringalbum ~safe ~extension album stats roles format substitutes keys inside format by mapping keys with information inside album, stats and roles. If extension is Some, the key SkhcQuery.Keys.extension is mapped to extension. safe indicates whether '/', '\\' or 0x00 character should by replaced by an underscore.
val album_metadata :
safe:bool ->
extension:string option ->
SkhcMetadata.Metadata.t ->
string ->
stringalbum_metadata ~safe ~extension ~title metadata format substitutes keys inside format by mapping keys with information inside metadata. album_metadata is similar to album except that Int, Float and Bool.flag fields are not populated. If extension is Some, the key SkhcQuery.Keys.extension is mapped to extension. safe indicates whether '/', '\\' or 0x00 character should by replaced by an underscore.
artist ~safe ~extension artist format substitutes keys inside format by mapping keys with information inside artist. If extension is Some, the key SkhcQuery.Keys.extension is mapped to extension. safe indicates whether '/', '\\' or 0x00 character should by replaced by underscore.