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

doc(IO): explain lifetime of gen a bit

Browse source
This commit is contained in:
Simon Cruanes 2019-11-08 11:27:01 -06:00
parent 11d081a612
commit edcd97a7ed
1 changed files with 18 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
src/core/CCIO.mli
View file

@ -21,7 +21,7 @@
with_in "/tmp/input"
(fun ic ->
let chunks = read_chunks ic in
with_out ~flags:[Open_binary] ~mode:0o644 "/tmp/output"
with_out ~flags:[Open_binary; Open_creat] ~mode:0o644 "/tmp/output"
(fun oc ->
write_gen oc chunks
)
@ -29,6 +29,23 @@
) ;;
]}
- Note that the lifetime of an IO generator is tied to the underlying
channel. In the example above, [chunks] must be used in the scope of [ic].
This will raise an error:
{[
# CCIO.(
let chunks =
with_in "/tmp/input"
(fun ic ->read_chunks ic)
in
with_out ~flags:[Open_binary;Open_creat] ~mode:0o644 "/tmp/output"
(fun oc ->
write_gen oc chunks
)
) ;;
]}
@since 0.6
@before 0.12 was in 'containers.io', now moved into 'containers'