BatFileFile manipulation.
val lines_of : string -> string BatEnum.tlines_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.
count_lines filename count the number of lines in given file. Lines are read by the stdlib's input_line function.
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_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 permission and pass it as argument to open_in, open_out, with_file_in or with_file_out.
val default_permission : permissionDefault permissions.
val user_read : permissionGive the current user permission to read the file. Ignored under Windows.
val user_write : permissionGive the current user permission to write the file
val user_exec : permissionGive the current user permission to execute the file. Ignored under Windows.
val group_read : permissionGive the permission to read the file to the group containing the user. Ignored under Windows.
val group_write : permissionGive the permission to write the file to the group containing the user. Ignored under Windows.
val group_exec : permissionGive the permission to execute the file to the group containing the user. Ignored under Windows.
val other_read : permissionGive the permission to read the file to the rest of the world. Ignored under Windows.
val other_write : permissionGive the permission to modify the file to the rest of the world. Ignored under Windows.
val other_exec : permissionGive the permission to execute the file to the rest of the world. Ignored under Windows.
val perm : permission list -> permissionJoin permissions
val unix_perm : int -> permissionCreate a permission from a Unix-style octal integer. See your favorite Unix documentation on chmod for more details.
val set_permissions : string -> permission -> unitSet the permissions on a file.
val chmod : string -> permission -> unittype open_in_flag = [ ]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.
type open_out_flag = [ ]Flags governing file output; they correspond to the relevant flags to the POSIX 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.
type open_temporary_out_flag = [ | open_out_flag | |
| `delete_on_exit | (* Should the file be deleted when program ends? *) |
]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.
val 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.