package containers

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

High-level Functions on top of Unix
1. Calling Commands

package containers

containers
- CCArray
  - S
  - Sub
- CCBool
- CCError
  - MONAD
  - Traverse
    
    M
- CCFloat
- CCFormat
- CCFun
  - Monad
    
    X
- CCHash
- CCHashtbl
  - COUNTER
  - DEFAULT
  - Make
    
    X
  - MakeCounter
    
    X
  - MakeDefault
    
    X
  - S
- CCHeap
  - Make
    
    E
  - PARTIAL_ORD
  - S
- CCInt
- CCList
  - Assoc
  - Idx
  - MONAD
  - Ref
  - Set
  - Traverse
    
    M
  - Zipper
- CCMap
  - Make
    
    O
  - S
- CCOpt
- CCOrd
- CCPair
- CCPrint
  - MONAD_IO
  - MakeIO
    
    M
- CCRandom
- CCRef
- CCSet
  - Make
    
    O
  - S
- CCString
  - S
  - Split
  - Sub
- CCVector
- Containers
  - Array
  - Format
  - List
  - Random
  - String
containers.bigarray
- CCBigstring
containers.data
- CCBV
- CCCache
- CCDeque
- CCFQueue
- CCFlatHashtbl
  - HASHABLE
  - Make
    
    X
  - S
- CCIntMap
- CCMixmap
  - Make
    
    X
  - ORD
  - S
- CCMixtbl
- CCMultiMap
  - BIDIR
  - Make
    
    K
    
    V
  - MakeBidir
    
    L
    
    R
  - OrderedType
  - S
- CCMultiSet
  - Make
    
    O
  - S
- CCPersistentArray
- CCPersistentHashtbl
  - HashedType
  - Make
    
    H
  - S
- CCRingBuffer
  - Array
    
    Byte
    
    Make
    
    Elt
    
    S
  - Byte
  - Make
    
    Array
    
    X
  - MakeFromArray
    
    A
  - S
    
    Array
- CCTrie
  - Make
    
    W
  - MakeArray
    
    X
  - MakeList
    
    X
  - ORDERED
  - S
  - String
  - WORD
containers.io
- CCIO
  - File
containers.iter
- CCKList
  - MONAD
  - Traverse
    
    M
- CCKTree
  - Dot
  - pset
containers.misc
- Containers_misc
containers.sexp
- CCSexp
  - Traverse
- CCSexpM
  - MONAD
  - MakeDecode
    
    M
- CCSexpStream
  - L
  - Lexer
  - ParseGen
  - Source
    
    Manual
containers.string
- Containers_string
containers.thread
- CCFuture
  - Infix
  - Timer
- CCLock
containers.unix
- CCUnix

Legend:
Library
Module
Module type
Parameter
Class
Class type

High-level Functions on top of Unix

Some useful functions built on top of Unix.

status: unstable

since 0.10

type 'a or_error = [

| `Ok of 'a
| `Error of string

]

type 'a gen = unit -> 'a option

Calling Commands

val escape_str : Buffer.t -> string -> unit

Escape a string so it can be a shell argument.

type call_result =
  < stdout : string
  ; stderr : string
  ; status : Unix.process_status
  ; errcode : int >

val call : 
  ?bufsize:int ->
  ?stdin:[ `Gen of string gen | `Str of string ] ->
  ?env:string array ->
  ('a, Buffer.t, unit, call_result) Pervasives.format4 ->
  'a

call cmd wraps the result of Unix.open_process_full cmd into an object. It reads the full stdout and stderr of the subprocess before returning.

parameter stdin
if provided, the generator or string is consumed and fed to the subprocess input channel, which is then closed.

parameter bufsize
buffer size used to read stdout and stderr

parameter env
environment to run the command in