package yocaml

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

yocaml
- Yocaml
  - Action
    
    Dynamic
    
    Static
  - Archetype
    
    Article
    
    Articles
    
    Datetime
    
    Infix
    
    Page
  - Cache
  - Cmd
  - Data
    
    Validation
    
    Infix
    
    Syntax
  - Deps
  - Diagnostic
  - Eff
    
    Infix
    
    List
    
    Syntax
  - Make
    
    Data_reader
    
    DP
    
    Eff
    
    Pipeline
    
    Runtime
    
    Runtime
  - Markup
    
    Toc
  - Metadata
  - Nel
  - Path
    
    Infix
  - Pipeline
  - Reader
    
    Over
    
    T
  - Required
    
    DATA_INJECTABLE
    
    DATA_PROVIDER
    
    DATA_READABLE
    
    DATA_READER
    
    Eff
    
    Pipeline
    
    DATA_TEMPLATE
    
    RUNNER
    
    Runtime
    
    RUNTIME
  - Runtime
    
    Make
    
    Runtime
  - Sexp
    
    Canonical
    
    Provider
  - Slug
  - Task
    
    Dynamic
    
    Infix
    
    Static
    
    Syntax

Legend:
Library
Module
Module type
Parameter
Class
Class type

A Runtime is an execution context (ie, Unix or Git). They describe the entry point of a YOCaml program and abstract the file system.

Parameters

module Runtime : Required.RUNTIME

Signature

val run : 
  ?custom_error_handler:
    (Stdlib.Format.formatter -> Data.Validation.custom_error -> unit) ->
  (unit -> unit Eff.t) ->
  unit Runtime.t

Runs a YOCaml program (and interprets its effects, youhou).