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 (11)

Authors

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

Maintainers

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

Sources

yocaml-2.7.0.tbz
sha256=89a74bd5cb37e580e45e4ed3d43b07b2cca5af9ab7f98966c48fe9730dc4af2e
sha512=ae77555570320c28c47d748e75056ccc44bb43cddf6fef70e8b556254fd809d67b915b313bd1833c28581db1fdeefbe34e81d5548744d6ecabe466ee1ef6284c

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.