Format (p.shakuhachi.0.3.0.doc.shakuhachi.libs.Skhclibs.Format)

Source

val filename_f : 
  extension:string ->
  SkhcConfig.Config.t ->
  SkhcMetadata.Metadata.t ->
  SkhcQuery.Format.t ->
  string

filename ~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.

since 0.3.0

Source

val filename : 
  extension:string ->
  SkhcConfig.Config.t ->
  SkhcMetadata.Metadata.t ->
  string ->
  string

filename ~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.

Source

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 ->
  string

music music album roles properties format substitutes keys inside format by mapping keys with information inside music, album, roles and properties.

Source

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 ->
  string

music music album roles properties format substitutes keys inside format by mapping keys with information inside music, album, roles and properties.

since 0.3.0

Source

val album : 
  safe:bool ->
  extension:string option ->
  SkhcDb.Album.t ->
  SkhcDb.Album.Stats.t ->
  (string * SkhcDb.Roles.t) SkhcDb.Ids.Map.t ->
  string ->
  string

album ~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.

Source

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 ->
  string

album ~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.

since 0.3.0

Source

val album_metadata : 
  safe:bool ->
  extension:string option ->
  SkhcMetadata.Metadata.t ->
  string ->
  string

album_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.

Source

val album_metadata_f : 
  safe:bool ->
  extension:string option ->
  SkhcMetadata.Metadata.t ->
  SkhcQuery.Format.t ->
  string

album_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.

since 0.3.0

Source

val artist : 
  safe:bool ->
  extension:string option ->
  SkhcDb.Artist.t ->
  string ->
  string

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.

Source

val artist_f : 
  safe:bool ->
  extension:string option ->
  SkhcDb.Artist.t ->
  SkhcQuery.Format.t ->
  string

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.

since 0.3.0