package b0

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Variables
Process environement
Process environments as assignments

package b0

b0.b00
- B00
  - Env
  - Exec
  - File_cache
    
    Stats
  - Guard
  - Memo
    
    Fut
  - Op
    
    Map
    
    Mkdir
    
    Read
    
    Set
    
    Spawn
    
    Write
  - Op_cache
  - Tool
b0.care
- B0_github
  - Issue
  - Pages
  - Release
  - Repo
- B0_machine
- B0_odoc
  - Compile
    
    Dep
    
    Writes
  - Html
    
    Dep
    
    Writes
  - Html_fragment
  - Support_files
    
    Writes
- B0_trace
  - Compilation_database
  - Trace_event
- B0_ui
  - Browser
  - Cli
    
    Arg
    
    B0_std
  - Editor
  - Memo
  - Pager
- B0_vcs
  - Git
- B0_web
  - Htmlg
    
    Att
    
    El
  - Http
  - Json
  - Jsong
  - Jsonq
b0.std
- B0_std
  - Char
    
    Ascii
  - Cmd
  - Conv
    
    Bin
    
    Txt
  - Fmt
  - Fpath
    
    Map
    
    Set
  - Hash
    
    Murmur3_128
    
    T
    
    Xxh_64
  - List
  - Log
  - Option
  - Os
    
    Cmd
    
    Dir
    
    Env
    
    Fd
    
    File
    
    Path
  - Result
  - String
    
    Ascii
    
    Map
    
    Set
  - Time
    
    Span
  - Tty

Legend:
Library
Module
Module type
Parameter
Class
Class type

Environment variables.

Variables

val find : empty_to_none:bool -> string -> string option

find ~empty_to_none name is the value of the environment variable name in the current process environment, if defined. If empty_to_none is true (default), None is returned if the variable value is the empty string.

val find_value : 
  (string -> ('a, string) result) ->
  empty_to_none:bool ->
  string ->
  ('a, string) result option

find_value parse ~empty_to_none name is Option.bind parse (find ~empty_to_none name), except the error message of parse is tweaked to mention name in case of error.

Process environement

type t = string String.Map.t

The type for process environments.

val empty : t

empty is String.Map.empty.

val override : t -> by:t -> t

override env ~by:o overrides the definitions in env by o.

val current : unit -> (t, string) result

current () is the current process environment.

Process environments as assignments

type assignments = string list

The type for environments as lists of strings of the form "var=value".

val current_assignments : unit -> (assignments, string) result

current_assignments () is the current process environment as assignments.

val of_assignments : ?init:t -> string list -> (t, string) result

of_assignments ~init ss folds over strings in ss, cuts them at the leftmost '=' character and adds the resulting pair to init (defaults to empty). If the same variable is bound more than once, the last one takes over.

val to_assignments : t -> assignments

to_assignments env is env's bindings as assignments.