simon/ocaml-containers
1
0
Fork 0
mirror of https://github.com/c-cube/ocaml-containers.git synced 2025-12-06 11:15:31 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

minor doc details

Browse source
This commit is contained in:
Simon Cruanes 2014-08-05 01:30:33 +02:00
parent 0660fde92b
commit 1214bfe777
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
core/CCIO.mli
View file

@ -30,15 +30,19 @@ A simple abstraction over blocking IO, with strict evaluation. This is in
no way an alternative to Lwt/Async if you need concurrency. no way an alternative to Lwt/Async if you need concurrency.
@since NEXT_RELEASE @since NEXT_RELEASE
*)
(**
Examples: Examples:
- obtain the list of lines of a file: - obtain the list of lines of a file:
{[ {[
let l = CCIO.((with_in "/tmp/some_file" >>>= read_lines) |> run_exn);; let l = CCIO.((with_in "/tmp/some_file" >>>= read_lines) |> run_exn);;
]} ]}
- transfer one file into another: - transfer one file into another:
{[ {[
# let a = CCIO.( # let a = CCIO.(
with_in "input" >>>= fun ic -> with_in "input" >>>= fun ic ->
@ -49,7 +53,6 @@ let l = CCIO.((with_in "/tmp/some_file" >>>= read_lines) |> run_exn);;
# run a;; # run a;;
]} ]}
*) *)
type 'a t type 'a t
@ -266,7 +269,7 @@ module Seq : sig
val output : ?sep:string -> out_channel -> string t -> unit io val output : ?sep:string -> out_channel -> string t -> unit io
(** [output oc seq] outputs every value of [seq] into [oc], separated (** [output oc seq] outputs every value of [seq] into [oc], separated
with the optional argument [sep] (default: ["\n"]). with the optional argument [sep] (default: None).
It blocks until all values of [seq] are produced and written to [oc]. *) It blocks until all values of [seq] are produced and written to [oc]. *)
end end