fileutils 0.5.0 · OCaml Package

exception FileDoesntExist of FilePath.filename

exception RecursiveLink of FilePath.filename

type !'a error_handler = string -> 'a -> unit

exception Fatal of string

type action_link =

| Follow
| Skip
| SkipInform of FilePath.filename -> unit
| AskFollow of FilePath.filename -> bool

type interactive =

| Force
| Ask of FilePath.filename -> bool

type base_permission = {

sticky : bool;
exec : bool;
write : bool;
read : bool;

}

type permission = {

user : base_permission;
group : base_permission;
other : base_permission;

}

val permission_of_int : int -> permission

val int_of_permission : permission -> int

module Mode : sig ... end

type size =

| TB of int64
| GB of int64
| MB of int64
| KB of int64
| B of int64

val byte_of_size : size -> int64

val size_add : size -> size -> size

val size_compare : ?fuzzy:bool -> size -> size -> int

val string_of_size : ?fuzzy:bool -> size -> string

type kind =

| Dir
| File
| Dev_char
| Dev_block
| Fifo
| Socket
| Symlink

type stat = {

kind : kind;
is_link : bool;
permission : permission;
size : size;
owner : int;
group_owner : int;
access_time : float;
modification_time : float;
creation_time : float;
device : int;
inode : int;

}

val stat : ?dereference:bool -> FilePath.filename -> stat

exception UmaskError of string

type umask_error = [

| `Exc of exn
| `NoStickyBit of int

]

val umask : 
  ?error:umask_error error_handler ->
  ?mode:[< `Octal of int | `Symbolic of Mode.t ] ->
  [< `Octal of int -> 'a | `Symbolic of Mode.t -> 'a ] ->
  'a

val umask_apply : int -> int

type test_file =

| Is_dev_block
| Is_dev_char
| Is_dir
| Exists
| Is_file
| Is_set_group_ID
| Has_sticky_bit
| Is_link
| Is_pipe
| Is_readable
| Is_writeable
| Size_not_null
| Size_bigger_than of size
| Size_smaller_than of size
| Size_equal_to of size
| Size_fuzzy_equal_to of size
| Is_socket
| Has_set_user_ID
| Is_exec
| Is_owned_by_user_ID
| Is_owned_by_group_ID
| Is_newer_than of FilePath.filename
| Is_older_than of FilePath.filename
| Is_newer_than_date of float
| Is_older_than_date of float
| And of test_file * test_file
| Or of test_file * test_file
| Not of test_file
| Match of string
| True
| False
| Has_extension of FilePath.extension
| Has_no_extension
| Is_parent_dir
| Is_current_dir
| Basename_is of FilePath.filename
| Dirname_is of FilePath.filename
| Custom of FilePath.filename -> bool

val test : 
  ?match_compile:(FilePath.filename -> FilePath.filename -> bool) ->
  test_file ->
  FilePath.filename ->
  bool

exception ChmodError of string

type chmod_error = [

| `Exc of exn

]

val chmod : 
  ?error:chmod_error error_handler ->
  ?recurse:bool ->
  [< `Octal of Unix.file_perm | `Symbolic of Mode.t ] ->
  FilePath.filename list ->
  unit

exception MkdirError of string

type mkdir_error = [

| `DirnameAlreadyUsed of FilePath.filename
| `Exc of exn
| `MissingComponentPath of FilePath.filename
| `MkdirChmod of FilePath.filename * Unix.file_perm * string * chmod_error

]

val mkdir : 
  ?error:mkdir_error error_handler ->
  ?parent:bool ->
  ?mode:[< `Octal of Unix.file_perm | `Symbolic of FileUtilMode.t ] ->
  FilePath.filename ->
  unit

exception RmError of string

type rm_error = [

| `DirNotEmpty of FilePath.filename
| `Exc of exn
| `NoRecurse of FilePath.filename

]

val rm : 
  ?error:rm_error error_handler ->
  ?force:interactive ->
  ?recurse:bool ->
  FilePath.filename list ->
  unit

exception CpError of string

type cp_error = [

| `CannotChmodDstDir of FilePath.filename * exn
| `CannotCopyDir of FilePath.filename
| `CannotCopyFilesToFile of FilePath.filename list * FilePath.filename
| `CannotCreateDir of FilePath.filename * exn
| `CannotListSrcDir of FilePath.filename * exn
| `CannotOpenDstFile of FilePath.filename * exn
| `CannotOpenSrcFile of FilePath.filename * exn
| `CannotRemoveDstFile of FilePath.filename * exn
| `DstDirNotDir of FilePath.filename
| `ErrorRead of FilePath.filename * exn
| `ErrorWrite of FilePath.filename * exn
| `Exc of exn
| `NoSourceFile of FilePath.filename
| `PartialWrite of FilePath.filename * int * int
| `SameFile of FilePath.filename * FilePath.filename
| `UnhandledType of FilePath.filename * kind

]

val cp : 
  ?follow:action_link ->
  ?force:interactive ->
  ?recurse:bool ->
  ?preserve:bool ->
  ?error:cp_error error_handler ->
  FilePath.filename list ->
  FilePath.filename ->
  unit

exception MvError of string

type mv_error = [

| `Exc of exn
| `MvCp of FilePath.filename * FilePath.filename * string * cp_error
| `MvRm of FilePath.filename * string * rm_error
| `NoSourceFile

]

val mv : 
  ?error:mv_error error_handler ->
  ?force:interactive ->
  FilePath.filename ->
  FilePath.filename ->
  unit

type touch_time_t =

| Touch_now
| Touch_file_time of FilePath.filename
| Touch_timestamp of float

val touch : 
  ?atime:bool ->
  ?mtime:bool ->
  ?create:bool ->
  ?time:touch_time_t ->
  FilePath.filename ->
  unit

val filter : test_file -> FilePath.filename list -> FilePath.filename list

val ls : FilePath.filename -> FilePath.filename list

val pwd : unit -> FilePath.filename

val readlink : FilePath.filename -> FilePath.filename

val which : 
  ?path:FilePath.filename list ->
  FilePath.filename ->
  FilePath.filename

val cmp : 
  ?skip1:int ->
  FilePath.filename ->
  ?skip2:int ->
  FilePath.filename ->
  int option

val du : FilePath.filename list -> size * (FilePath.filename * size) list

val find : 
  ?follow:action_link ->
  ?match_compile:(FilePath.filename -> FilePath.filename -> bool) ->
  test_file ->
  FilePath.filename ->
  ('a -> FilePath.filename -> 'a) ->
  'a ->
  'a

package fileutils