package yocaml

You can search for identifiers within the package.

in-package search v0.2.0

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
    
    Map
  - 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

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

type t =

| Atom of string
| Node of t list

S-Expression AST.

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

type invalid =

| Invalid_sexp of t * string

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

val atom : string -> t

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

val node : t list -> t

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

Serialization

Tools for serializing a Sexp.

val to_string : t -> string

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

Deserialization

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

from_string str Try deserializing a string in Sexp.

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

from_string str Try deserializing a string in Sexp.

module Canonical : sig ... end

S-Canonical expression used to describe compressed data sources.

Utils

val equal : t -> t -> bool

Equality between t.

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

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

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

Pretty-printer for t with indentation.

module Provider : sig ... end