From b1a392ba44558ca1a1a6ae3e93682f9b544864f2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hugo=20H=C3=B6rnquist?= Date: Sat, 12 Nov 2022 03:38:24 +0100 Subject: Document (hnh util io). --- doc/ref/guile/util.texi | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/doc/ref/guile/util.texi b/doc/ref/guile/util.texi index f9e6527e..72463407 100644 --- a/doc/ref/guile/util.texi +++ b/doc/ref/guile/util.texi @@ -337,3 +337,34 @@ Generates a UUID-v4 string. @defun uuid Generates an implementation defined (but guaranteed valid) UUID. @end defun + +@subsection IO + +Provided by module @code{(hnh util io)}. + +@defun open-input-port path +@defunx open-output-port path +Like @code{open-*-file}, but ``-'' gives @code{standard-@{input,output@}}. +@end defun + +@defun read-lines port +Return a list of all lines read from port. +@end defun + +@defun with-atomic-output-to-file filename thunk +Same functionality as the regular @var{with-output-to-file}, but +with the difference that either everything is written, or nothing +is written, and if anything is written it's all written atomicaly at +once (the original file will never contain an intermidiate state). +Does NOT handle race conditions between threads. + +propagates the return value of @var{thunk} upon successfully writing +the file, and @code{#f} otherwise. +@end defun + +@defun call-with-tmpfile proc [#:tmpl ``/tmp/file-XXXXXXX''] +@end defun + +@defun read-file path +Open file at path, and return its content as a string. +@end defun -- cgit v1.2.3