File and its operations are NOT thread safe, use MVar File in multiple threads.

Note this is a differet data type from Z.IO.FileSystem 's one, the Input and Output instance use thread pool version functions.

libuv implements read and write method with both implict and explict offset capable. Implict offset interface is provided by Input / Output instances. Explict offset interface is provided by readFileP / writeFileP.

init a file Resource, which open a file when used.

Resource closing will wait for the referencing counter goes down to zero (no reading or writing is in process), which can be a problem if you are using multiple readers or writers in multiple threads. In that case you have to stop all reading or writing thread if you don't want to block the resource thread.

Read file with given offset

Read length may be smaller than buffer size.

Write buffer to file

This function will loop until all bytes are written.

Note on linux files opened with O_APPEND behave differently since this function use pwrite:

POSIX requires that opening a file with the O_APPEND flag should have no effect
on the location at which pwrite() writes data. However, on Linux,
if a file is opened with O_APPEND, pwrite() appends data to the end of the file,
regardless of the value of offset.

Return File fd.

Set file's system offset.

Equivalent to lseek64(3).

Quickly open a file and read its content.

Quickly open a file and read its content as UTF8 text.

Quickly open a file and write some content.

Quickly open a file and write some content as UTF8 text.

Quickly open a file and read its content as a JSON value. Throw OtherError with name EPARSE if JSON value is not parsed.

Quickly open a file and write a JSON Value.

File bundled with offset.

Reading or writing using Input / Output instance will automatically increase offset. FilePtr and its operations are NOT thread safe, use MVar FilePtr in multiple threads.

The notes on linux writeFileP applied to FilePtr too.

Create a file offset bundle from an File.

Get current offset.

Change current offset.

Equivalent to mkdir(2).

Note mode is currently not implemented on Windows. On unix you should set execute bit if you want the directory is accessable, e.g. 0o777.

Recursive directory creation function. Like mkdir, but makes all intermediate-level directories needed to contain the leaf directory.

Equivalent to mkdir -p,

Note mode is currently not implemented on Windows. On unix you should set execute bit if you want the directory is accessable(so that child folder can be created), e.g. DEFAULT_DIR_MODE.

Equivalent to unlink(2).

Equivalent to http://linux.die.net/man/3/mkdtemp

Creates a temporary directory in the most secure manner possible. There are no race conditions in the directory’s creation. The directory is readable, writable, and searchable only by the creating user ID. The user of mkdtemp() is responsible for deleting the temporary directory and its contents when done with it.

Note: the argument is the prefix of the temporary directory, so no need to add XXXXXX ending.

Equivalent to https://man7.org/linux/man-pages/man3/mkstemp.3.html

Make a temporary file under system getTempDir and automatically clean after used.

>>> withResource (initTempFile "foo") $ printStd
File 13

Make a temporary directory under system getTempDir and automatically clean after used.

>>> withResource (initTempDir "foo") $ printStd
"/tmp/fooxfWR0L"

Equivalent to rmdir(2).

Note this function may inherent OS limitations such as argument must be an empty folder.

Removes a file or directory at path together with its contents and subdirectories. Symbolic links are removed without affecting their targets. If the path does not exist, nothing happens.

Equivalent to scandir(3).

Note Unlike scandir(3), this function does not return the “.” and “..” entries.

Note On Linux, getting the type of an entry is only supported by some file systems (btrfs, ext2, ext3 and ext4 at the time of this writing), check the getdents(2) man page.

Find all files and directories within a given directory with a predicator.

 import Z.IO.FileSystem.FilePath (splitExtension)
 -- find all haskell source file within current dir
 scandirRecursively "."  (\ p _ -> (== ".hs") . snd <$> splitExtension p)

Does given path exist?

Returns True if the argument file exists and is either a file or a symbolic link to a file, and False otherwise.

Returns True if the argument directory exists and is either a directory or a symbolic link to a directory, and False otherwise.

If given path is a symbolic link?

If given path is a directory or a symbolic link to a directory?

If given path is a file or a symbolic link to a file?

Shortcut to \ st -> stMode st .&. S_IFMT == S_IFLNK

Note you should use lstat to get the link's stat.

Shortcut to \ st -> stMode st .&. S_IFMT == S_IFDIR

Shortcut to \ st -> stMode st .&. S_IFMT == S_IFREG

Equivalent to stat(2)

Equivalent to lstat(2)

Equivalent to fstat(2)

Equivalent to stat(2)

Return Nothing instead of throwing NoSuchThing if the file doesn't exist.

Equivalent to lstat(2)

Return Nothing instead of throwing NoSuchThing if the link doesn't exist.

Equivalent to rename(2).

Note On Windows if this function fails with UV_EBUSY, UV_EPERM or UV_EACCES, it will retry to rename the file up to four times with 250ms wait between attempts before giving up. If both path and new_path are existing directories this function will work only if target directory is empty.

Equivalent to fsync(2).

Equivalent to fdatasync(2).

Equivalent to ftruncate(2).

Copies a file from path to new_path.

Warning: If the destination path is created, but an error occurs while copying the data, then the destination path is removed. There is a brief window of time between closing and removing the file where another process could access the file.

Equivalent to access(2) on Unix. Windows uses GetFileAttributesW().

Equivalent to chmod(2).

Equivalent to fchmod(2).

Equivalent to utime(2).

libuv choose Double type due to cross platform concerns, we only provide micro-second precision.

Equivalent to futime(3).

Same precision notes with utime.

Equivalent to lutime(3).

Same precision notes with utime.

Equivalent to link(2).

Equivalent to symlink(2).

| Note On Windows the flags parameter can be specified to control how the symlink will be created.

• SYMLINK_DIR: indicates that path points to a directory.
• SYMLINK_JUNCTION: request that the symlink is created using junction points.

On other platforms these flags are ignored.

Equivalent to readlink(2).

Equivalent to realpath(3) on Unix. Windows uses GetFinalPathNameByHandle.

Warning This function has certain platform-specific caveats that were discovered when used in Node.

• macOS and other BSDs: this function will fail with UV_ELOOP if more than 32 symlinks are found while resolving the given path. This limit is hardcoded and cannot be sidestepped.

• Windows: while this function works in the common case, there are a number of corner cases where it doesn’t:

  • Paths in ramdisk volumes created by tools which sidestep the Volume Manager (such as ImDisk) cannot be resolved.
  • Inconsistent casing when using drive letters.
  • Resolved path bypasses subst’d drives.

While this function can still be used, it’s not recommended if scenarios such as the above need to be supported. The background story and some more details on these issues can be checked here.

Note This function is not implemented on Windows XP and Windows Server 2003. On these systems, UV_ENOSYS is returned.

Equivalent to chown(2).

Equivalent to fchown(2).

Equivalent to lchown(2).

Default mode for file open, 0x666(readable and writable).

Default mode for open, 0x755.

00700 user (file owner) has read, write and execute permission

00400 user has read permission

00200 user has write permission

00100 user has execute permission

00070 group has read, write and execute permission

00040 group has read permission

00020 group has write permission

00010 group has execute permission

00007 others have read, write and execute permission

00004 others have read permission

This is the file type mask.

This is the file type constant of a symbolic link.

This is the file type constant of a directory file.

This is the file type constant of a regular file.

The file is opened in append mode. Before each write, the file offset is positioned at the end of the file.

The file is created if it does not already exist.

File IO is done directly to and from user-space buffers, which must be aligned. Buffer size and address should be a multiple of the physical sector size of the block device, (DO NOT USE WITH Z-IO's BufferedIO)

The file is opened for synchronous IO. Write operations will complete once all data and a minimum of metadata are flushed to disk.

Note O_DSYNC is supported on Windows via FILE_FLAG_WRITE_THROUGH.

If the O_CREAT flag is set and the file already exists, fail the open.

Note In general, the behavior of O_EXCL is undefined if it is used without O_CREAT. There is one exception: on Linux 2.6 and later, O_EXCL can be used without O_CREAT if pathname refers to a block device. If the block device is in use by the system (e.g., mounted), the open will fail with the error EBUSY.

Atomically obtain an exclusive lock.

Note UV_FS_O_EXLOCK is only supported on macOS and Windows. (libuv: Changed in version 1.17.0: support is added for Windows.)

Do not update the file access time when the file is read.

Note O_NOATIME is not supported on Windows.

If the path is a symbolic link, fail the open.

Note O_NOFOLLOW is not supported on Windows.

Open the file for read-only access.

Open the file for read-write access.

Open the symbolic link itself rather than the resource it points to.

The file is opened for synchronous IO. Write operations will complete once all data and all metadata are flushed to disk.

Note O_SYNC is supported on Windows via FILE_FLAG_WRITE_THROUGH.

If the file exists and is a regular file, and the file is opened successfully for write access, its length shall be truncated to zero.

Open the file for write-only access.

Access is intended to be random. The system can use this as a hint to optimize file caching.

Note O_RANDOM is only supported on Windows via FILE_FLAG_RANDOM_ACCESS.

The file is temporary and should not be flushed to disk if possible.

Note O_SHORT_LIVED is only supported on Windows via FILE_ATTRIBUTE_TEMPORARY.

Access is intended to be sequential from beginning to end. The system can use this as a hint to optimize file caching.

Note O_SEQUENTIAL is only supported on Windows via FILE_FLAG_SEQUENTIAL_SCAN.

The file is temporary and should not be flushed to disk if possible.

Note O_TEMPORARY is only supported on Windows via FILE_ATTRIBUTE_TEMPORARY.

Flags control copying.

• COPYFILE_EXCL: If present, uv_fs_copyfile() will fail with UV_EEXIST if the destination path already exists. The default behavior is to overwrite the destination if it exists.
• COPYFILE_FICLONE: If present, uv_fs_copyfile() will attempt to create a copy-on-write reflink. If the underlying platform does not support copy-on-write, then a fallback copy mechanism is used.
• COPYFILE_FICLONE_FORCE: If present, uv_fs_copyfile() will attempt to create a copy-on-write reflink. If the underlying platform does not support copy-on-write, or an error occurs while attempting to use copy-on-write, then an error is returned.

On Windows the flags parameter can be specified to control how the symlink will be created:

• SYMLINK_DIR: indicates that path points to a directory.
• SYMLINK_JUNCTION: request that the symlink is created using junction points.