package containers

You can search for identifiers within the package.

in-package search v0.2.0

package containers

containers
- CCArray
  - Infix
  - MONO_ARRAY
- CCArrayLabels
  - Infix
  - MONO_ARRAY
- CCBool
- CCCanonical_sexp
  - Make
    
    Sexp
- CCChar
  - Infix
- CCEither
- CCEqual
  - Infix
- CCEqualLabels
  - Infix
- CCFloat
  - Infix
- CCFormat
  - ANSI_codes
  - Dump
  - Infix
- CCFun
  - Infix
  - Monad
    
    X
- CCHash
- CCHashtbl
  - Make
    
    X
  - Poly
  - S
- CCHeap
  - Make
    
    E
  - Make_from_compare
    
    E
  - PARTIAL_ORD
  - S
  - TOTAL_ORD
- CCIO
  - File
- CCInt
  - Infix
- CCInt32
  - Infix
- CCInt64
  - Infix
- CCList
  - Assoc
  - Infix
  - MONAD
  - Ref
  - Traverse
    
    M
- CCListLabels
  - Assoc
  - Infix
  - MONAD
  - Ref
  - Traverse
    
    M
- CCMap
  - Make
    
    O
  - S
- CCNativeint
  - Infix
- CCOpt
  - Infix
- CCOption
  - Infix
- CCOrd
  - Infix
- CCPair
- CCParse
  - Debug_
  - Error
  - Infix
  - Position
  - Slice
  - U
- CCRandom
- CCRef
- CCResult
  - Infix
  - MONAD
  - Traverse
    
    M
- CCSeq
  - Infix
  - MONAD
  - Traverse
    
    M
- CCSet
  - Make
    
    O
  - S
- CCSexp
  - Decoder
  - Make
    
    Decoder
    
    Sexp
- CCSexp_intf
  - BASIC_SEXP
  - S
    
    Decoder
  - S0
  - SEXP
- CCSexp_lex
- CCShimsArrayLabels_
- CCShimsArray_
- CCShimsEither_
- CCShimsFormat_
- CCShimsFun_
- CCShimsInt_
- CCShimsList_
- CCShimsMkLetList_
  - Make
    
    X
  - S
- CCShimsMkLet_
  - Make
    
    X
  - Make2
    
    X
  - S
  - S2
- CCShims_
- CCString
  - Find
  - Infix
  - Split
- CCStringLabels
  - Find
  - Infix
  - Split
- CCUtf8_string
- CCVector
- Containers
  - Hashtbl
    
    HashedType
    
    MakeSeeded
    
    H
    
    S
    
    SeededHashedType
    
    SeededS
- ContainersLabels
  - Hashtbl
    
    HashedType
    
    MakeSeeded
    
    H
    
    S
    
    SeededHashedType
    
    SeededS
containers.codegen
- Containers_codegen
  - Bitfield
  - Code
containers.monomorphic
- CCMonomorphic
- CCMonomorphicShims_
containers.top
- Containers_top
containers.unix
- CCUnix
  - Infix

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t = string

A file should be represented by its absolute path, but currently this is not enforced.

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 or access rights are wrong.

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).

raises Sys_error
in case of error (e.g. permission denied).

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

val read_exn : t -> string

Read the content of the given file, or raises some exception.

raises Sys_error
in case of error.

since 0.16

val read : t -> string or_error

Read the content of the given file.

since 0.16

val append_exn : t -> string -> unit

Append the given string into the given file, possibly raising.

raises Sys_error
in case of error.

since 0.16

val append : t -> string -> unit or_error

Append the given string into the given file.

since 0.16

val write_exn : t -> string -> unit

Write the given string into the given file, possibly raising.

raises Sys_error
in case of error.

since 0.16

val write : t -> string -> unit or_error

Write the given string into the given file.

since 0.16

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

val walk : t -> walk_item gen

Like 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.)

raises Sys_error
in case of error (e.g. permission denied) during iteration.

val walk_iter : t -> walk_item iter

Like walk but with an imperative iterator.

since 3.6

val walk_l : t -> walk_item list

Like walk but returns a list (therefore it's eager and might take some time on large directories).

since 1.1

val walk_seq : t -> walk_item Seq.t

Like walk but returns a Seq

since 3.6

val show_walk_item : walk_item -> string

val with_temp : 
  ?temp_dir:string ->
  prefix:string ->
  suffix:string ->
  (string -> 'a) ->
  'a

with_temp ~prefix ~suffix f will call f with the name of a new temporary file (located in temp_dir). After f returns, the file is deleted. Best to be used in combination with with_out. See Filename.temp_file.

since 0.17