bos 0.2.1 · OCaml Package

bos

To focus the search input from anywhere on the page, press the 'S' key.

in-package search v0.1.0

On This Page

Interpreted programs
Results
Astring
Bos
Fmt & Logs

package bos

bos
- Bos
  - Cmd
  - OS
    
    Arg
    
    Cmd
    
    Dir
    
    Env
    
    File
    
    Path
    
    Mode
    
    U
  - Pat
bos_setup
- Bos_setup
  - Char
  - Cmd
  - Fmt
  - Logs
  - OS
  - Pat
  - R
  - String

Legend:
Library
Module
Module type
Parameter
Class
Class type

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

type ('a, 'b) result = ('a, 'b) result =

| Ok of 'a
| Error of 'b

The type for results.

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

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

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

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

module R : sig ... end

Astring

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