package yocaml_yaml

You can search for identifiers within the package.

in-package search v0.2.0

Yocaml plugin for dealing with Yaml as metadata provider

Install

dune-project

Dependency

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

Authors

T

The XHTMLBoy <xhtmlboi@gmail.com>

Maintainers

T

The XHTMLBoy <xhtmlboi@gmail.com>

Sources

yocaml-2.4.1.tbz

sha256=cfc7c139116d6881b1d0bc7af706b8f8ceb6cd1f5be67d621944388731ab9d6c

sha512=9d1a075a6a9d3c8bae9ae4e389ada0a5b7818b3993ef9dd45af65070434b86bb56c349db5d0149134d449495415c28e2bfca993a20d5e4b7d16263f7231334c3

doc/yocaml_yaml/Yocaml_yaml/index.html

Module `Yocaml_yaml`Source

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

Sourcetype t = Yaml.value

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.

On This Page

Reading file with metadata
Data Provider