package yocaml

You can search for identifiers within the package.

in-package search v0.2.0

YOCaml
- CHANGES
- README
- Generic validation of structured data
- Effect abstraction
- Library yocaml
  - Yocaml
    
    Required
    
    DATA_PROVIDER
    
    DATA_READABLE
    
    DATA_INJECTABLE
    
    DATA_TEMPLATE
    
    DATA_READER
    
    Eff
    
    Pipeline
    
    RUNTIME
    
    RUNNER
    
    Runtime
    
    Nel
    
    Path
    
    Infix
    
    Map
    
    Cache
    
    Deps
    
    Metadata
    
    Archetype
    
    Datetime
    
    Infix
    
    Page
    
    Article
    
    Articles
    
    Cmd
    
    Slug
    
    Toc
    
    Datetime
    
    Task
    
    Infix
    
    Syntax
    
    Static
    
    Dynamic
    
    Pipeline
    
    Action
    
    Static
    
    Dynamic
    
    Eff
    
    List
    
    Infix
    
    Syntax
    
    Runtime
    
    Make
    
    Make
    
    Runtime
    
    Data_reader
    
    Eff
    
    Pipeline
    
    Sexp
    
    Canonical
    
    Provider
    
    Data
    
    Validation
    
    Infix
    
    Syntax
    
    Diagnostic
    
    Reader
    
    Over
    
    Markup
    
    Toc
- Sources
  - yocaml
    
    action.ml
    
    archetype.ml
    
    cache.ml
    
    cmd.ml
    
    data.ml
    
    deps.ml
    
    diagnostic.ml
    
    eff.ml
    
    lexicon.ml
    
    make.ml
    
    markup.ml
    
    metadata.ml
    
    nel.ml
    
    path.ml
    
    pipeline.ml
    
    reader.ml
    
    runtime.ml
    
    sexp.ml
    
    sexp_provider.ml
    
    slug.ml
    
    task.ml
    
    yocaml.ml
    
    yocaml__.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module type `Required.DATA_READABLE`

Describes a type capable of being readable as metadata of type Yocaml.Data.t. Used to lift a module into a validator for data described by a Yocaml.Required.DATA_PROVIDER.

type t

The type that describes the metadata.

val entity_name : string

Assigns a name to an entity (a set of metadata).

val neutral : (t, provider_error) result

Describes a neutral element, as a fallback in the absence of metadata. The function can return an error if the request is mandatory.

val validate : Data.t -> t Data.Validation.validated_value

validate raw_data Validates a data item represented by type Yocaml.Data.t and projects it into a value of type t.

package yocaml

Module type Required.DATA_READABLE

Module type `Required.DATA_READABLE`