package alba

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

alba.albalib
- Albalib
  - Alba_console
    
    Make
    
    IO
    
    Directory
    
    File
    
    In
    
    Out
    
    M
    
    Path
    
    Process
    
    Stderr
    
    Stdout
  - Ast
    
    Expression
  - Build_context
    
    Application
    
    Lambda
    
    Product
    
    Typed
  - Builder
    
    Print
    
    P
  - Context
    
    Name_map
    
    Pretty
    
    P
  - Gamma
  - Gamma_algo
    
    GAMMA
    
    Make
    
    Gamma
  - Gamma_holes
  - Operator
  - Parser_lang
    
    Command
    
    Make
    
    Error
    
    Final
    
    Problem
    
    SIG
    
    Error
  - Term
    
    Application_info
    
    Inductive
    
    Lambda_info
    
    Monadic
    
    M
    
    Pi_info
    
    Sort
    
    Value
  - Term_printer
    
    GAMMA
    
    Pretty
    
    G
    
    P
    
    String_print
    
    G
  - Typecheck
  - Unifier
    
    HOLES
    
    Make
    
    H
alba.fmlib_native
- Fmlib_native
  - Native_io
    
    IO
    
    Directory
    
    File
    
    In
    
    Out
    
    M
    
    Path
    
    Process
    
    Stderr
    
    Stdout
alba.fmlib_node
- Fmlib_node
  - File_system
  - Io_buffer
    
    Read
    
    W
    
    Write
    
    R
  - Node_io
    
    IO
    
    Directory
    
    File
    
    In
    
    Out
    
    M
    
    Path
    
    Process
    
    Stderr
    
    Stdout
  - Path
  - Process
  - Readline

Legend:
Library
Module
Module type
Parameter
Class
Class type

Make (Base) transforms a basic implementation of an io module which conforms to the signature SIG into a full implementation of an io module.

Parameters

module Base : SIG

Signature

module M : Module_types.MONAD

include Module_types.MONAD

type 'a t

The type of the monad containing values of type 'a

val return : 'a -> 'a t

return a makes a monadic container containing the value a.

val (>>=) : 'a t -> ('a -> 'b t) -> 'b t

m >>= f extracts the value a from the monadic container m and returns f a.

val (>=>) : ('a -> 'b t) -> ('b -> 'c t) -> 'a -> 'c t

f >=> g composition of the two monadic functions f and g.

f >=> g is equivalent to fun a -> f a >>= g.

val map : ('a -> 'b) -> 'a t -> 'b t

map f m maps the values in the monadic container m with the function f.

val join : 'a t t -> 'a t

Remove one level of container. join m is equivalent to mm >>= fun m -> m.

val (<*>) : ('a -> 'b) t -> 'a t -> 'b t

f <*> m applies the function contained in f to the content of the monadic container m and injects the result into a new monadic container.

module Path : sig ... end

module Process : sig ... end

module Directory : sig ... end

module File : sig ... end

module Stdout : sig ... end

Write to standard output (usually the screen).

module Stderr : sig ... end

Write to standard error (usually the screen).

val cli_loop : 
  'a ->
  ('a -> string option) ->
  ('a -> string -> 'a t) ->
  ('a -> 'a t) ->
  'a t

cli_loop state prompt next stop runs a cli loop which starts in state state and prompts its users with the string returned by prompt state. If prompt state returns None, the cli_loop is ended.

If the user enters a line, the command next state line is performed.

If prompt state returns None or the user ends its input by pressing ctrl-d, the command stop state is performed.

Example:

The following command starts a cli_loop and prompts the user at most 5 times with i> and echoes back the input of the user.

cli_loop
    0
    (fun i ->
        if i < 5 then
            Some (string_of_int i ^ "> ")
        else
            None)
    (fun i line ->
        Stdout.line line >>= fun _ -> return (i + 1))
    (fun _ -> return ())