package yocaml_yaml

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

Install 

dune-project
 Dependency

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

Authors

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

Maintainers

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

Sources

yocaml-3.0.1.tbz
sha256=9091d2c578cfbd15ff87f3d0dc9a64f9e02e714a22d37da14823083ec46a51b1
sha512=22231c3852a8345b6a6947c367e7cc311b57ccf2869a5d7c681384e7c0c18f0a17217ebc04ae9523833941ac71f136185cdc75090fe0849fa42a4f8a01d5e203

doc/yocaml_yaml/Yocaml_yaml/index.html

Module Yocaml_yamlSource

Plugin for describing metadata with Yaml, based on the Yaml package.

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.