package yocaml

You can search for identifiers within the package.

in-package search v0.2.0

YOCaml
- 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 `Yocaml.Sexp`Source

include module type of Sexp

Definition

An S-Expression is a data structure with an extremely simple recursive syntax tree. It is made up of atoms (character strings) and nodes (also S-Expressions).

Sourcetype t =

| Atom of string
| Node of t list

S-Expression AST.

Sourcetype parsing_error =

| Nonterminated_node of int
| Nonterminated_atom of int
| Expected_number_or_colon of char * int
| Expected_number of char * int
| Unexepected_character of char * int
| Premature_end_of_atom of int * int

Errors that can occur when parsing S-expressions.

Sourcetype invalid =

| Invalid_sexp of t * string

Used to describe an invalid S-expression (correctly parsed but does not respect a schema).

Sourceval atom : string -> t

atom x lift a given string, x, into a t.

Sourceval node : t list -> t

nod x lift a given list of t, x, into a t.

Serialization

Tools for serializing a Sexp.

Sourceval to_string : t -> string

convert a S-expression to a string (with indent).

Deserialization

Sourceval from_string : string -> (t, parsing_error) result

from_string str Try deserializing a string in Sexp.

Sourceval from_seq : char Seq.t -> (t, parsing_error) result

from_string str Try deserializing a string in Sexp.

Sourcemodule Canonical : sig ... end

S-Canonical expression used to describe compressed data sources.

Utils

Sourceval equal : t -> t -> bool

Equality between t.

Sourceval pp : Format.formatter -> t -> unit

Pretty-printer for t (mostly used for debugging issue).

Sourceval pp_pretty : Format.formatter -> t -> unit

Pretty-printer for t with indentation.

Sourcemodule Provider : sig ... end