package yocaml

  1. Overview
  2. Docs

Module Make.Data_readerSource

Builds metadata reader functions based on a data provider.

Describes a provider for reading Metadata from a DATA_PROVIDER.

Parameters

Signature

type t = DP.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.

Sourcemodule Eff : sig ... end

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

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

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

Produces a type t value from a string.

val normalize : t -> Data.t

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