A simple abstraction over blocking IO, with strict evaluation. This is in no way an alternative to Lwt/Async if you need concurrency.
Examples:
let l = CCIO.((with_in "/tmp/some_file" >>>= read_lines) |> run_exn);;# let a = CCIO.(
with_in "input" >>>= fun ic ->
with_out ~flags:[Open_creat] "output" >>>= fun oc ->
Seq.chunks 512 ic
|> Seq.output oc
) ;;
# run a;;type 'a io = 'a tA value of type 'a with_finalizer is similar to a value 'a t but also contains a finalizer that must be run to cleanup. See (>>>=) to get rid of it.
Wait for the result of an action, then use a function to build a new action and execute it
val return : 'a -> 'a tJust return a value
bind f a runs the action a and applies f to its result to obtain a new action. It then behaves exactly like this new action.
val pure : 'a -> 'a tval fail : string -> 'a tfail msg fails with the given message. Running the IO value will return an `Error variant
val (>>>=) : 'a with_finalizer -> ('a -> 'b t) -> 'b tSame as (>>=), but taking the finalizer into account. Once this IO value is done executing, the finalizer is executed and the resource, fred.
register_printer p register p as a possible failure printer. If run a raises an exception e, p e is evaluated. If p e = Some msg then the error message will be msg, otherwise other printers will be tried
val with_in :
?mode:int ->
?flags:Pervasives.open_flag list ->
string ->
Pervasives.in_channel with_finalizerOpen an input file with the given optional flag list. It yields a in_channel with a finalizer attached. See (>>>=) to use it.
val read : Pervasives.in_channel -> Bytes.t -> int -> int -> int tRead a chunk into the given string
val read_line : Pervasives.in_channel -> string option tRead a line from the channel. Returns None if the input is terminated.
val read_lines : Pervasives.in_channel -> string list tRead all lines eagerly
val read_all : Pervasives.in_channel -> string tRead the whole channel into a buffer, then converted into a string
val with_out :
?mode:int ->
?flags:Pervasives.open_flag list ->
string ->
Pervasives.out_channel with_finalizerSame as with_in but for an output channel
val with_out_a :
?mode:int ->
?flags:Pervasives.open_flag list ->
string ->
Pervasives.out_channel with_finalizerSimilar to with_out but with the Open_append and Open_creat flags activated
val write : Pervasives.out_channel -> string -> int -> int -> unit tval write_str : Pervasives.out_channel -> string -> unit tval write_buf : Pervasives.out_channel -> Buffer.t -> unit tval write_line : Pervasives.out_channel -> string -> unit tval flush : Pervasives.out_channel -> unit tIterators on chunks of bytes, or lines, or any other value using combinators. Those iterators are usable only once, because their source might be usable only once (think of a socket)
module Seq : sig ... endHow to list recursively files in a directory:
CCIO.(
File.read_dir ~recurse:true (File.make "/tmp")
>>= Seq.output ~sep:"\n" stdout
) |> CCIO.run_exn ;;See File.walk if you also need to list directories.
module File : sig ... endmodule Raw : sig ... end