package yocaml

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Functor API
Applicative API
Selective API
Monad API
1. Type
2. Functions
3. Infix operators
4. Syntax

yocaml
- Yocaml
  - Build
    
    Infix
  - Date
  - Deps
    
    Monoid
    
    Infix
    
    Writer
    
    Infix
    
    Monad
    
    Infix
    
    Syntax
    
    Syntax
  - Effect
    
    Applicative
    
    Infix
    
    Syntax
    
    Freer
    
    Applicative
    
    Infix
    
    Syntax
    
    Functor
    
    Infix
    
    Infix
    
    Monad
    
    Infix
    
    Syntax
    
    Selective
    
    Infix
    
    Syntax
    
    Syntax
    
    To_monad
    
    Monad
    
    Functor
    
    Infix
    
    Infix
    
    Monad
    
    Infix
    
    Syntax
    
    Selective
    
    Infix
    
    Syntax
    
    Syntax
    
    To_monad
    
    Monad
    
    Traverse
  - Error
  - Filepath
  - Key_value
    
    DESCRIBABLE
    
    Jsonm_descriptor
    
    Jsonm_object
    
    Jsonm_validator
    
    Make_validator
    
    KV
    
    VALIDABLE
    
    VALIDATOR
  - Languages
    
    ISO639
  - Lexicon
  - Log
  - Metadata
    
    Article
    
    Articles
    
    Date
    
    INJECTABLE
    
    Page
    
    READABLE
    
    RENDERABLE
    
    VALIDABLE
  - Mime
  - Rss
    
    Category
    
    Channel
    
    Cloud
    
    Enclosure
    
    Guid
    
    Image
    
    Item
    
    Source
  - Runtime
    
    Make
    
    R
    
    RUNTIME
  - Try
    
    Applicative
    
    Infix
    
    Syntax
    
    Traversable
    
    A
    
    Infix
    
    Syntax
    
    Functor
    
    Infix
    
    Infix
    
    Monad
    
    Infix
    
    Syntax
    
    Traversable
    
    M
    
    Infix
    
    Syntax
    
    Syntax
  - Util
  - Validate
    
    Alt
    
    Infix
    
    Applicative
    
    Infix
    
    Syntax
    
    Traversable
    
    A
    
    Infix
    
    Syntax
    
    Functor
    
    Infix
    
    Infix
    
    Monad
    
    Infix
    
    Syntax
    
    Traversable
    
    M
    
    Infix
    
    Syntax
    
    Selective
    
    Infix
    
    Syntax
    
    Syntax

Legend:
Library
Module
Module type
Parameter
Class
Class type

type 'a f =
  (< file_exists : unit
    ; target_exists : unit
    ; get_modification_time : unit
    ; target_modification_time : unit
    ; read_file : unit
    ; write_file : unit
    ; content_changes : unit
    ; read_dir : unit
    ; log : unit
    ; command : unit
    ; throw : unit
    ; raise_ : unit >,
    'a)
    effects

The parametric type (which, unlike a Preface_specs.Free_monad don't need to be a Preface_specs.Functor).

type _ t =

| Return : 'a -> 'a t
| Bind : 'b f * ('b -> 'a t) -> 'a t

The type held by Freer monad.

type ('a, 'b) handle = ('a -> 'b) -> 'a f -> 'b

type 'a handler = {

handler : 'b. ('b, 'a) handle;

}

The handler type. Which is a Natural transformation from the Freer Monad to an unwrapped Identity monad.

val perform : 'a f -> 'a t

Create a new 'a t from a 'a f.

val run : 'a handler -> 'a t -> 'a

Execute a given handler for given data

module To_monad
  (Monad : Preface_specs.Monad.CORE) : 
  Preface_specs.Freer_monad.TO_MONAD
    with type 'a t := 'a t
     and type 'a f := 'a f
     and type 'a monad := 'a Monad.t

Functor API

A Freer monad is also an Preface_specs.Functor.

module Functor : Preface_specs.Functor.API with type 'a t = 'a t

Applicative API

A Freer monad is also an Preface_specs.Applicative.

module Applicative : Preface_specs.Applicative.API with type 'a t = 'a t

Selective API

A Freer monad is also an Preface_specs.Selective.

module Selective : Preface_specs.Selective.API with type 'a t = 'a t

Monad API

A Freer monad is also (obviously) a Preface_specs.Monad.

module Monad : Preface_specs.Monad.API with type 'a t = 'a t

Type

Functions

include Preface_specs.Monad.WITH_RETURN with type 'a t := 'a t

include Preface_specs.Bind.WITH_BIND with type 'a t := 'a t

val bind : ('a -> 'b t) -> 'a t -> 'b t

bind f m passes the result of computation m to function f.

include Preface_specs.Monad.WITH_RETURN with type 'a t := 'a t

include Preface_specs.Bind.WITH_MAP_AND_JOIN with type 'a t := 'a t

val map : ('a -> 'b) -> 'a t -> 'b t

Mapping over from 'a to 'b over 'a t to 'b t.

val join : 'a t t -> 'a t

join remove one level of monadic structure, projecting its bound argument into the outer level.

include Preface_specs.Monad.WITH_RETURN with type 'a t := 'a t

val return : 'a -> 'a t

Lift a value from 'a into a new 'a t.

include Preface_specs.Bind.WITH_KLEISLI_COMPOSITION with type 'a t := 'a t

val compose_left_to_right : ('a -> 'b t) -> ('b -> 'c t) -> 'a -> 'c t

Composing monadic functions using Kleisli Arrow (from left to right).

val compose_right_to_left : ('b -> 'c t) -> ('a -> 'b t) -> 'a -> 'c t

Composing monadic functions using Kleisli Arrow (from right to left).

val lift : ('a -> 'b) -> 'a t -> 'b t

Mapping over from 'a to 'b over 'a t to 'b t.

val lift2 : ('a -> 'b -> 'c) -> 'a t -> 'b t -> 'c t

Mapping over from 'a and 'b to 'c over 'a t and 'b t to 'c t.

val lift3 : ('a -> 'b -> 'c -> 'd) -> 'a t -> 'b t -> 'c t -> 'd t

Mapping over from 'a and 'b and 'c to 'd over 'a t and 'b t and 'c t to 'd t.

val replace : 'a -> 'b t -> 'a t

Create a new 'a t, replacing all values in the 'b t by given a value of 'a.

val void : 'a t -> unit t

Create a new unit t, replacing all values in the 'a t by unit.

Infix operators

module Infix : Preface_specs.Monad.INFIX with type 'a t = 'a t

val (=|<) : ('a -> 'b) -> 'a t -> 'b t

Infix version of CORE.map.

val (>|=) : 'a t -> ('a -> 'b) -> 'b t

Infix flipped version of CORE.map.

val (>>=) : 'a t -> ('a -> 'b t) -> 'b t

Infix flipped version of CORE.bind.

val (=<<) : ('a -> 'b t) -> 'a t -> 'b t

Infix version of CORE.bind.

val (>=>) : ('a -> 'b t) -> ('b -> 'c t) -> 'a -> 'c t

Infix version of CORE.compose_left_to_right.

val (<=<) : ('b -> 'c t) -> ('a -> 'b t) -> 'a -> 'c t

Infix version of OPERATION.compose_right_to_left.

val (>>) : unit t -> 'b t -> 'b t

Sequentially compose two actions, discarding any value produced by the first.

val (<<) : 'a t -> unit t -> 'a t

Sequentially compose two actions, discarding any value produced by the second.

val (<$>) : ('a -> 'b) -> 'a t -> 'b t

Infix version of Preface_specs.Functor.CORE.map.

val (<&>) : 'a t -> ('a -> 'b) -> 'b t

Flipped and infix version of Preface_specs.Functor.CORE.map.

val (<$) : 'a -> 'b t -> 'a t

Infix version of Preface_specs.Functor.OPERATION.replace.

val ($>) : 'a t -> 'b -> 'b t

Flipped and infix version of Preface_specs.Functor.OPERATION.replace.

Syntax

module Syntax : Preface_specs.Monad.SYNTAX with type 'a t = 'a t

val let* : 'a t -> ('a -> 'b t) -> 'b t

Syntactic shortcuts for flipped version of CORE.bind:

let* x = e in f is equals to bind (fun x -> f) e.

val let+ : 'a t -> ('a -> 'b) -> 'b t

Syntactic shortcuts for flipped version of CORE.map:

let+ x = e in f is equals to map (fun x -> f) e.