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 (21)

Authors

  1. A
    Anil Madhavapeddy
  2. T
    Thomas Leonard

Maintainers

  1. A
    anil@recoil.org

Sources

eio-1.5.tbz
sha256=7d70d1f5fb2b7190bf1ab28fffeb272da51ffe6d6c9c7c94e0485fabdf3b3fda
sha512=4582ac2fb2f8616b3d8ae9670eb7913a78085899b14044408801b30a34fed6c4d32971ba72eedb0cbc3d82c057610cf81c482090e75e2985330fcde96478ac5e

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.