package bos

  1. Overview
  2. Docs
Basic OS interaction for OCaml

Install 

dune-project
 Dependency

erratique.ch Readme Changelog ISC License Edit opam file Versions (3)

Authors

  1. Daniel Bünzli

Maintainers

  1. Daniel Bünzli

Sources

bos-0.2.0.tbz
sha256=8c27b2cbc89a9e7ca32ecf8b232ab5c8c91c395dc4d1916cc9ddbe8c3a8e20e8
md5=aeae7447567db459c856ee41b5a66fd2

doc/bos.setup/Bos_setup/index.html

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.2.0 - 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, 'b) Rresult.result =
  1. | Ok of 'a
  2. | Error of 'b

The type for results.

val (>>=) : ('a, 'b) Result.result -> ('a -> ('c, 'b) Result.result) -> ('c, 'b) Result.result

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

val (>>|) : ('a, 'b) Result.result -> ('a -> 'c) -> ('c, 'b) Result.result

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

module R : sig ... end

Astring

val strf : ('a, Format.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