package yocaml_otoml

  1. Overview
  2. Docs
Yocaml plugin for dealing with TOML as metadata provider

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (9)

Authors

  1. T
    The XHTMLBoy <xhtmlboi@gmail.com>

Maintainers

  1. T
    The XHTMLBoy <xhtmlboi@gmail.com>

Sources

yocaml-2.6.0.tbz
sha256=a006e9d52e520986d4262dfe7bfeba6a381f1423be32409494888d667d14ac73
sha512=8a25f1776e0bcd5e317484b681c67b0d6bb60952f0dd0942f44bf708fb3db03331522b4d8929e09c1926b213003bf14bb148468ddde35add0ad657b4d9237bd1

doc/yocaml_otoml/Yocaml_otoml/index.html

Module Yocaml_otomlSource

Plugin for describing metadata with TOML, based on the OTOML package.

Sourcetype t = Otoml.t

The type that describes the data provider

Reading file with metadata

Just as the Yocaml package describes a low-level interface for propagating effects, the Yocaml.Eff module, and an interface for composing arrows, via the Yocaml.Pipeline module, the plugin describes two sub-modules to serve the same needs.

module Eff : sig ... end

Describes the low-level interface for reading a file and parsing its metadata described by the type t.

module Pipeline : sig ... end

Describes the arrowized interface for reading a file and parsing its metadata.

Data Provider

As it is possible to describe metadata as a Data_provider.

Sourceval from_string : string -> (t, Yocaml.Required.provider_error) result

Produces a type t value from a string.

Sourceval normalize : t -> Yocaml.Data.t

Converts a value of type t into a value of type Yocaml.Data.t.