jon.recoil.org

Module Bos_setupSource

Quick setup for simple programs.

Linking against this module setups Logs and issuing:

open Bos_setup

in a module is sufficient to bring Rresult, Astring and Bos in scope. See also how to use this for interpreted programs.

Interpreted programs

To use Bos and this setup in an interpreted program, start the file with:

#!/usr/bin/env ocaml
#use "topfind"
#require "bos.setup"
open Bos_setup

To allow merlin to function correctly issue M-x merlin-use bos.setup in emacs or :MerlinUse bos.setup in vim.

Results

Sourcetype ('a, 'b) result = ('a, 'b) result =
  1. | Ok of 'a
  2. | Error of 'b

The type for results.

Sourceval (>>=) : ('a, 'b) result -> ('a -> ('c, 'b) result) -> ('c, 'b) result

(>>=) is R.(>>=).

Sourceval (>>|) : ('a, 'b) result -> ('a -> 'c) -> ('c, 'b) result

(>>|) is R.(>>|).

Sourcemodule R : sig ... end

Astring

Sourceval strf : ('a, Format.formatter, unit, string) format4 -> 'a

strf is Astring.strf.

Sourceval (^) : string -> string -> string

^ is Astring.(^).

Sourcemodule Char : sig ... end
Sourcemodule String : sig ... end

Bos

Sourcemodule Pat : sig ... end
Sourcemodule Cmd : sig ... end
Sourcemodule OS : sig ... end

Fmt & Logs

Note. The following aliases are strictly speaking not needed but they allow to end-users to use them by expressing a single dependency towards bos.setup.

Sourcemodule Fmt : sig ... end
Sourcemodule Logs : sig ... end