simon/ocaml-containers
1
0
Fork 0
mirror of https://github.com/c-cube/ocaml-containers.git synced 2025-12-08 20:25:28 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

document errors in CCIO (close #86)

Browse source
This commit is contained in:
Simon Cruanes 2016-11-30 20:52:18 +01:00
parent 0b3e1cea77
commit d1e33cd135
1 changed files with 13 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
src/core/CCIO.mli
View file

@ -46,6 +46,7 @@ val with_in : ?mode:int -> ?flags:open_flag list ->
(** Open an input file with the given optional flag list, calls the function (** Open an input file with the given optional flag list, calls the function
on the input channel. When the function raises or returns, the on the input channel. When the function raises or returns, the
channel is closed. channel is closed.
@raise Sys_error in case of error (same as {!open_in} and {!close_in})
@param flags opening flags (default [[Open_text]]). [Open_rdonly] is used in any cases *) @param flags opening flags (default [[Open_text]]). [Open_rdonly] is used in any cases *)
val read_chunks : ?size:int -> in_channel -> string gen val read_chunks : ?size:int -> in_channel -> string gen
@ -77,12 +78,14 @@ val with_out : ?mode:int -> ?flags:open_flag list ->
string -> (out_channel -> 'a) -> 'a string -> (out_channel -> 'a) -> 'a
(** Same as {!with_in} but for an output channel (** Same as {!with_in} but for an output channel
@param flags opening flags (default [[Open_creat; Open_trunc; Open_text]]). @param flags opening flags (default [[Open_creat; Open_trunc; Open_text]]).
@raise Sys_error in case of error (same as {!open_out} and {!close_out})
[Open_wronly] is used in any cases *) [Open_wronly] is used in any cases *)
val with_out_a : ?mode:int -> ?flags:open_flag list -> val with_out_a : ?mode:int -> ?flags:open_flag list ->
string -> (out_channel -> 'a) -> 'a string -> (out_channel -> 'a) -> 'a
(** Similar to {!with_out} but with the [[Open_append; Open_creat; Open_wronly]] (** Similar to {!with_out} but with the [[Open_append; Open_creat; Open_wronly]]
flags activated, to append to the file *) flags activated, to append to the file.
@raise Sys_error in case of error (same as {!open_out} and {!close_out}) *)
val write_line : out_channel -> string -> unit val write_line : out_channel -> string -> unit
(** Write the given string on the channel, followed by "\n" *) (** Write the given string on the channel, followed by "\n" *)
@ -102,6 +105,7 @@ val with_in_out : ?mode:int -> ?flags:open_flag list ->
string -> (in_channel -> out_channel -> 'a) -> 'a string -> (in_channel -> out_channel -> 'a) -> 'a
(** Combines {!with_in} and {!with_out}. (** Combines {!with_in} and {!with_out}.
@param flags opening flags (default [[Open_creat]]) @param flags opening flags (default [[Open_creat]])
@raise Sys_error in case of error
@since 0.12 *) @since 0.12 *)
(** {2 Misc for Generators} *) (** {2 Misc for Generators} *)
@ -145,7 +149,7 @@ module File : sig
(** [remove_exn path] tries to remove the file at [path] from the (** [remove_exn path] tries to remove the file at [path] from the
file system. file system.
{b Raises} [Sys_error] if there is no file at [path]. @raise Sys_error if there is no file at [path] or access rights are wrong.
@since 0.8 *) @since 0.8 *)
val remove : t -> unit or_error val remove : t -> unit or_error
@ -159,11 +163,13 @@ module File : sig
val read_dir : ?recurse:bool -> t -> t gen val read_dir : ?recurse:bool -> t -> t gen
(** [read_dir d] returns a sequence of files and directory contained (** [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) in the directory [d] (or an empty stream if [d] is not a directory)
@raise Sys_error in case of error (e.g. permission denied)
@param recurse if true (default [false]), sub-directories are also @param recurse if true (default [false]), sub-directories are also
explored *) explored *)
val read_exn : t -> string val read_exn : t -> string
(** Read the content of the given file, or raises some exception (** Read the content of the given file, or raises some exception
@raise Sys_error in case of error
@since 0.16 *) @since 0.16 *)
val read : t -> string or_error val read : t -> string or_error
@ -172,6 +178,7 @@ module File : sig
val append_exn : t -> string -> unit val append_exn : t -> string -> unit
(** Append the given string into the given file, possibly raising (** Append the given string into the given file, possibly raising
@raise Sys_error in case of error
@since 0.16 *) @since 0.16 *)
val append : t -> string -> unit or_error val append : t -> string -> unit or_error
@ -180,6 +187,7 @@ module File : sig
val write_exn : t -> string -> unit val write_exn : t -> string -> unit
(** Write the given string into the given file, possibly raising (** Write the given string into the given file, possibly raising
@raise Sys_error in case of error
@since 0.16 *) @since 0.16 *)
val write : t -> string -> unit or_error val write : t -> string -> unit or_error
@ -192,7 +200,8 @@ module File : sig
(** Similar to {!read_dir} (with [recurse=true]), this function walks (** Similar to {!read_dir} (with [recurse=true]), this function walks
a directory recursively and yields either files or directories. a directory recursively and yields either files or directories.
Is a file anything that doesn't satisfy {!is_directory} (including Is a file anything that doesn't satisfy {!is_directory} (including
symlinks, etc.) *) symlinks, etc.)
@raise Sys_error in case of error (e.g. permission denied) during iteration *)
val show_walk_item : walk_item -> string val show_walk_item : walk_item -> string
@ -204,5 +213,6 @@ module File : sig
After [f] returns, the file is deleted. Best to be used in After [f] returns, the file is deleted. Best to be used in
combination with {!with_out}. combination with {!with_out}.
See {!Filename.temp_file} See {!Filename.temp_file}
@raise Sys_error in case of error
@since 0.17 *) @since 0.17 *)
end end