package eio

  1. Overview
  2. Docs
Effect-based direct-style IO API for OCaml

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (22)

Authors

  1. A
    Anil Madhavapeddy
  2. T
    Thomas Leonard

Maintainers

  1. A
    anil@recoil.org

Sources

eio-1.6.tbz
sha256=c1f04986b401094176494863dde1ca9b292b59fdc679a9d7023e558d80fb5b15
sha512=92ed8cf20300b8a4e0141bdbc373c0803c5a24530cb65852637d905fff4a5b956a8859a00a424034ff78c1112da9b0391194bcd558326168bdebd1ce683a8890

doc/eio.mock/Eio_mock/Handler/index.html

Module Eio_mock.HandlerSource

Control how a mock responds.

This module is mostly useful when writing custom mocks. Individual mocks usually provide convenience wrappers around this.

Sourcetype 'a t

A handler that provides values of type 'a.

Sourcetype 'a actions = 'a Action.t list
Sourceval make : 'a Action.t -> 'a t

make default_action is a new handler that initially always runs default_action.

Sourceval set_handler : 'a t -> (unit -> 'a) -> unit

set_handler t fn sets (replaces) the function to be called whenever the handler is run.

Sourceval seq : 'a t -> 'a actions -> unit

seq t actions sets a handler function that performs the next action in actions on each call. When there are no more actions, it runs the default handler.

Sourceval run : 'a t -> 'a

run t is used by mocks to run their handlers.

Sourceval run_default_action : 'a t -> 'a

run_default_action t runs the default handler passed to make.