Module Bos_setup

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.

v0.1.6 - homepage

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

type ('a, 'b) result = ('a'bRresult.result =
| Ok of 'a
| Error of 'b

The type for results.

val (>>=) : ('a'bResult.result ‑> ('a ‑> ('c'bResult.result) ‑> ('c'bResult.result

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

val (>>|) : ('a'bResult.result ‑> ('a ‑> 'c) ‑> ('c'bResult.result

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

module R : sig ... end

Astring

val strf : ('aFormat.formatter, unit, string) Pervasives.format4 ‑> 'a

strf is Astring.strf.

val (^) : string ‑> string ‑> string

^ is Astring.(^).

module Char : sig ... end
module String : sig ... end

Bos

module Pat : sig ... end
module Cmd : sig ... end
module 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.

module Fmt : sig ... end
module Logs : sig ... end