package shakuhachi
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=8bd4675792ec93d705e68d4e43dc04aa1124fcaf644ae3a1a3fda68464276f95
sha512=712efcbe13e6e9d3336f72c2c25d4b41225cdd245f21adeeadc8aa4ad31ca9c905077e0873a3d1165d7c09357c009c859c4a7cd9c2d0c9bffc27144525594e72
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_f :
extension:string ->
SkhcConfig.Config.t ->
SkhcMetadata.Metadata.t ->
SkhcQuery.Format.t ->
stringfilename ~extension config metadata format substitutes keys inside format by mapping keys with information inside metadata. extension maps to the filename's extension. Substituated values are guaranted to not contain any '/', '\\' or 0x00 character.
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. Substituated values are 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 music_f :
SkhcDb.MusicFile.t ->
SkhcDb.Album.t ->
(string * SkhcDb.Roles.t) SkhcDb.Ids.Map.t ->
SkhcMetadata.Metadata.Values.t SkhcMetadata.Metadata.Properties.t ->
SkhcQuery.Format.t ->
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 for substituated values.
val album_f :
safe:bool ->
extension:string option ->
SkhcDb.Album.t ->
SkhcDb.Album.Stats.t ->
(string * SkhcDb.Roles.t) SkhcDb.Ids.Map.t ->
SkhcQuery.Format.t ->
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 for substituated values.
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 for substituated values.
val album_metadata_f :
safe:bool ->
extension:string option ->
SkhcMetadata.Metadata.t ->
SkhcQuery.Format.t ->
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 for substituated values.
val artist :
safe:bool ->
extension:string option ->
SkhcDb.Artist.t ->
string SkhcDb.Ids.Map.t ->
SkhcDb.Artist.Stats.t ->
string ->
stringartist ~safe ~extension artist albums stats 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 for substituated values.
val artist_f :
safe:bool ->
extension:string option ->
SkhcDb.Artist.t ->
string SkhcDb.Ids.Map.t ->
SkhcDb.Artist.Stats.t ->
SkhcQuery.Format.t ->
stringartist ~safe ~extension artist albums stats 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 for substituated values.