module BatFile:sig..end
val lines_of : string -> string BatEnum.tline_of name reads the contents of file name as an enumeration of lines.
The file is automatically closed once the last line has been reached or the
enumeration is garbage-collected.val write_lines : string -> string BatEnum.t -> unitwrite_lines name lines writes strings given by lines to file name with newline character appended to each line.val size_of : string -> intsize_of name returns the size of file name in bytes.val size_of_big : string -> Int64.tsize_of_big name returns the size of file name in bytes, as a 64-bit integer.
This function is provided as the size of a file larger than 1 Gb cannot
be represented with an int on a 32-bit machine.
File permissions are used when creating a file to allow controlling which users
may read, write or open that file. To use a permission, create a value of type
BatFile.permission and pass it as argument to BatFile.open_in, BatFile.open_out, BatFile.with_file_in or
BatFile.with_file_out.
type permission
val default_permission : permissionval user_read : permissionval user_write : permissionval user_exec : permissionval group_read : permissionval group_write : permissionval group_exec : permissionval other_read : permissionval other_write : permissionval other_exec : permissionval perm : permission list -> permissionval unix_perm : int -> permissionchmod
for more details.Invalid_argument if given number outside the [0, 0o777] rangeval set_permissions : string -> permission -> unitval chmod : string -> permission -> unit
typeopen_in_flag =[ `create | `excl | `mmap | `nonblock | `text ]
val open_in : ?mode:open_in_flag list ->
?perm:permission -> string -> BatInnerIO.inputopen_in file_name opens the file named file_name for reading.
Note You will need to close the file manually, with
BatIO.close_in. An alternative is to call with_file_in instead
of open_in.
Naming conventions for files are platform-dependent.
val with_file_in : ?mode:open_in_flag list ->
?perm:permission -> string -> (BatInnerIO.input -> 'a) -> 'awith_file_in file_name f opens the file named file_name for reading,
invokes f to process the contents of that file then, once f has returned
or triggered an exception, closes the file before proceeding.typeopen_out_flag =[ `append | `create | `excl | `nonblock | `text | `trunc ]
open() call. The default flags are
[`create; `trunc].val open_out : ?mode:open_out_flag list ->
?perm:permission -> string -> unit BatInnerIO.outputopen_out file_name opens the file named file_name for writing.
Note You will need to close the file manually, with
BatIO.close_out. An alternative is to call with_file_out
instead of open_out.
Naming conventions for files are platform-dependent.
val with_file_out : ?mode:open_out_flag list ->
?perm:permission -> string -> (unit BatInnerIO.output -> 'a) -> 'awith_file_out file_name f opens the file named file_name for writing,
invokes f to write onto that file then, once f has returned or triggered
an exception, closes the file before proceeding.typeopen_temporary_out_flag =[ `append | `create | `delete_on_exit | `excl | `nonblock | `text | `trunc ]
val open_temporary_out : ?mode:open_temporary_out_flag list ->
?prefix:string ->
?suffix:string -> ?temp_dir:string -> unit -> unit BatInnerIO.output * stringopen_temporary_out () opens a new temporary file for writing.output for writing in it.
Note You will need to close the file manually. An alternative is
to call with_temporary_out instead of open_out.
Naming conventions for files are platform-dependent.
prefix : a string which should appear at the start of your temporary file name
(by default "ocaml")suffix : a string which should appear at the end of your temporary file name
(by default "tmp")temp_dir : indicates what temp dir to useval with_temporary_out : ?mode:open_temporary_out_flag list ->
?prefix:string ->
?suffix:string ->
?temp_dir:string -> (unit BatInnerIO.output -> string -> 'a) -> 'awith_temporary_out f opens a new temporary file for writing, invokes f with
to write onto that file then, once f has returned or triggered an exception,
closes the file before proceeding.output for writing in it.
Naming conventions for files are platform-dependent.
prefix : a string which should appear at the start of your temporary file name
(by default "ocaml")suffix : a string which should appear at the end of your temporary file name
(by default "tmp")temp_dir : indicates what temp dir to use