package containers

You can search for identifiers within the package.

in-package search v0.2.0

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
- CCString
  - S
  - Split
  - Sub
- CCVector
containers.bigarray
- CCBigstring
containers.data
- CCBV
- CCCache
- CCDeque
- CCFQueue
- CCFlatHashtbl
  - HASHABLE
  - Make
    
    X
  - S
- CCMixtbl
- CCMultiMap
  - BIDIR
  - Make
    
    K
    
    V
  - MakeBidir
    
    L
    
    R
  - OrderedType
  - S
- CCMultiSet
  - Make
    
    O
  - S
- CCPersistentHashtbl
  - HashedType
  - Make
    
    H
  - S
- 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.pervasives
- CCPervasives
  - Array
  - List
  - Random
  - String
containers.sexp
- CCSexp
  - Traverse
- CCSexpM
  - MONAD
  - MakeDecode
    
    M
- CCSexpStream
  - L
  - Lexer
  - ParseGen
  - Source
    
    Manual
containers.string
- Containers_string
containers.thread
- CCFuture
  - Infix
  - Timer
- CCLock

Legend:
Library
Module
Module type
Parameter
Class
Class type

type 'a or_error = [

| `Ok of 'a
| `Error of string

]

type t = string

A file is always represented by its absolute path

val to_string : t -> string

val make : string -> t

Build a file representation from a path (absolute or relative)

val exists : t -> bool

val is_directory : t -> bool

val remove_exn : t -> unit

remove_exn path tries to remove the file at path from the file system.

Raises Sys_error if there is no file at path.

since 0.8

val remove : t -> unit or_error

Like remove_exn but with an error monad.

since 0.8

val remove_noerr : t -> unit

Like remove_exn but do not raise any exception on failure.

since 0.8

val read_dir : ?recurse:bool -> t -> t gen

read_dir d returns a sequence of files and directory contained in the directory d (or an empty stream if d is not a directory)

parameter recurse
if true (default false), sub-directories are also explored

type walk_item = [ `File | `Dir ] * t

val walk : t -> walk_item gen

similar to read_dir (with recurse=true), this function walks a directory recursively and yields either files or directories. Is a file anything that doesn't satisfy is_directory (including symlinks, etc.)

val show_walk_item : walk_item -> string