| Copyright | (c) Dong Han 2017~2019 |
|---|---|
| License | BSD |
| Maintainer | winterland1989@gmail.com |
| Stability | experimental |
| Portability | non-portable |
| Safe Haskell | None |
| Language | Haskell2010 |
Z.IO.FileSystem
Description
This module provide IO operations related to filesystem, operations are implemented using unsafe FFIs, which should be prefered when the operations' estimated time is short(<1ms), which is much common on modern SSDs.
Synopsis
- data File
- initFile :: HasCallStack => CBytes -> FileFlag -> FileMode -> Resource File
- readFile :: HasCallStack => File -> Ptr Word8 -> Int -> Int64 -> IO Int
- writeFile :: HasCallStack => File -> Ptr Word8 -> Int -> Int64 -> IO ()
- data FilePtr
- newFilePtr :: File -> Int64 -> IO FilePtr
- getFileOffset :: FilePtr -> IO Int64
- setFileOffset :: FilePtr -> Int64 -> IO ()
- data FileMode where
- pattern DEFAULT_MODE :: FileMode
- pattern S_IRWXU :: FileMode
- pattern S_IRUSR :: FileMode
- pattern S_IWUSR :: FileMode
- pattern S_IXUSR :: FileMode
- pattern S_IRWXG :: FileMode
- pattern S_IRGRP :: FileMode
- pattern S_IWGRP :: FileMode
- pattern S_IXGRP :: FileMode
- pattern S_IRWXO :: FileMode
- pattern S_IROTH :: FileMode
- data FileFlag where
- pattern O_APPEND :: FileFlag
- pattern O_CREAT :: FileFlag
- pattern O_DIRECT :: FileFlag
- pattern O_DSYNC :: FileFlag
- pattern O_EXCL :: FileFlag
- pattern O_EXLOCK :: FileFlag
- pattern O_NOATIME :: FileFlag
- pattern O_NOFOLLOW :: FileFlag
- pattern O_RDONLY :: FileFlag
- pattern O_RDWR :: FileFlag
- pattern O_SYMLINK :: FileFlag
- pattern O_SYNC :: FileFlag
- pattern O_TRUNC :: FileFlag
- pattern O_WRONLY :: FileFlag
- pattern O_RANDOM :: FileFlag
- pattern O_SHORT_LIVED :: FileFlag
- pattern O_SEQUENTIAL :: FileFlag
- pattern O_TEMPORARY :: FileFlag
- mkdir :: HasCallStack => CBytes -> FileMode -> IO ()
- unlink :: HasCallStack => CBytes -> IO ()
- mkdtemp :: HasCallStack => CBytes -> IO CBytes
- rmdir :: HasCallStack => CBytes -> IO ()
- data DirEntType
- scandir :: HasCallStack => CBytes -> IO [(CBytes, DirEntType)]
- data FStat = FStat {}
- data UVTimeSpec = UVTimeSpec {
- uvtSecond :: !CLong
- uvtNanoSecond :: !CLong
- stat :: HasCallStack => CBytes -> IO FStat
- lstat :: HasCallStack => CBytes -> IO FStat
- fstat :: HasCallStack => File -> IO FStat
- rename :: HasCallStack => CBytes -> CBytes -> IO ()
- fsync :: HasCallStack => File -> IO ()
- fdatasync :: HasCallStack => File -> IO ()
- ftruncate :: HasCallStack => File -> Int64 -> IO ()
- data CopyFileFlag where
- pattern COPYFILE_DEFAULT :: CopyFileFlag
- pattern COPYFILE_EXCL :: CopyFileFlag
- pattern COPYFILE_FICLONE :: CopyFileFlag
- copyfile :: HasCallStack => CBytes -> CBytes -> CopyFileFlag -> IO ()
- data AccessMode where
- pattern F_OK :: AccessMode
- pattern R_OK :: AccessMode
- pattern W_OK :: AccessMode
- pattern X_OK :: AccessMode
- data AccessResult
- access :: HasCallStack => CBytes -> AccessMode -> IO AccessResult
- chmod :: HasCallStack => CBytes -> FileMode -> IO ()
- fchmod :: HasCallStack => File -> FileMode -> IO ()
- utime :: HasCallStack => CBytes -> Double -> Double -> IO ()
- futime :: HasCallStack => File -> Double -> Double -> IO ()
- lutime :: HasCallStack => CBytes -> Double -> Double -> IO ()
- data SymlinkFlag where
- pattern SYMLINK_DEFAULT :: SymlinkFlag
- pattern SYMLINK_DIR :: SymlinkFlag
- pattern SYMLINK_JUNCTION :: SymlinkFlag
- link :: HasCallStack => CBytes -> CBytes -> IO ()
- symlink :: HasCallStack => CBytes -> CBytes -> SymlinkFlag -> IO ()
- readlink :: HasCallStack => CBytes -> IO CBytes
- realpath :: HasCallStack => CBytes -> IO CBytes
regular file devices
Arguments
| :: HasCallStack | |
| => CBytes | |
| -> FileFlag | |
| -> FileMode | Sets the file mode (permission and sticky bits),
but only if the file was created, see |
| -> Resource File |
Arguments
| :: HasCallStack | |
| => File | |
| -> Ptr Word8 | buffer |
| -> Int | buffer size |
| -> Int64 | file offset, pass -1 to use default(system) offset |
| -> IO Int | read length |
Read file with given offset
Read length may be smaller than buffer size.
Arguments
| :: HasCallStack | |
| => File | |
| -> Ptr Word8 | buffer |
| -> Int | buffer size |
| -> Int64 | file offset, pass -1 to use default(system) offset |
| -> IO () |
Write buffer to file
This function will loop until all bytes are written.
file offset bundle
Create a file offset bundle from an File.
opening constant
Bundled Patterns
| pattern DEFAULT_MODE :: FileMode | Default mode for open, 0o666(readable and writable). |
| pattern S_IRWXU :: FileMode | 00700 user (file owner) has read, write and execute permission |
| pattern S_IRUSR :: FileMode | 00400 user has read permission |
| pattern S_IWUSR :: FileMode | 00200 user has write permission |
| pattern S_IXUSR :: FileMode | 00100 user has execute permission |
| pattern S_IRWXG :: FileMode | 00070 group has read, write and execute permission |
| pattern S_IRGRP :: FileMode | 00040 group has read permission |
| pattern S_IWGRP :: FileMode | 00020 group has write permission |
| pattern S_IXGRP :: FileMode | 00010 group has execute permission |
| pattern S_IRWXO :: FileMode | 00007 others have read, write and execute permission |
| pattern S_IROTH :: FileMode | 00004 others have read permission |
Instances
Bundled Patterns
| pattern O_APPEND :: FileFlag | The file is opened in append mode. Before each write, the file offset is positioned at the end of the file. |
| pattern O_CREAT :: FileFlag | The file is created if it does not already exist. |
| pattern O_DIRECT :: FileFlag | 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 |
| pattern O_DSYNC :: FileFlag | The file is opened for synchronous IO. Write operations will complete once all data and a minimum of metadata are flushed to disk. Note |
| pattern O_EXCL :: FileFlag | If the Note In general, the behavior of |
| pattern O_EXLOCK :: FileFlag | 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.) |
| pattern O_NOATIME :: FileFlag | Do not update the file access time when the file is read. Note |
| pattern O_NOFOLLOW :: FileFlag | If the path is a symbolic link, fail the open. Note |
| pattern O_RDONLY :: FileFlag | Open the file for read-only access. |
| pattern O_RDWR :: FileFlag | Open the file for read-write access. |
| pattern O_SYMLINK :: FileFlag | Open the symbolic link itself rather than the resource it points to. |
| pattern O_SYNC :: FileFlag | The file is opened for synchronous IO. Write operations will complete once all data and all metadata are flushed to disk. Note |
| pattern O_TRUNC :: FileFlag | 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. |
| pattern O_WRONLY :: FileFlag | Open the file for write-only access. |
| pattern O_RANDOM :: FileFlag | Access is intended to be random. The system can use this as a hint to optimize file caching. Note |
| pattern O_SHORT_LIVED :: FileFlag | The file is temporary and should not be flushed to disk if possible. Note |
| pattern O_SEQUENTIAL :: FileFlag | Access is intended to be sequential from beginning to end. The system can use this as a hint to optimize file caching. Note |
| pattern O_TEMPORARY :: FileFlag | The file is temporary and should not be flushed to disk if possible. Note |
Instances
filesystem operations
mkdir :: HasCallStack => CBytes -> FileMode -> IO () Source #
Equivalent to mkdir(2).
Note mode is currently not implemented on Windows.
mkdtemp :: HasCallStack => CBytes -> IO CBytes Source #
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.
data DirEntType Source #
Constructors
| DirEntUnknown | |
| DirEntFile | |
| DirEntDir | |
| DirEntLink | |
| DirEntFIFO | |
| DirEntSocket | |
| DirEntChar | |
| DirEntBlock |
Instances
scandir :: HasCallStack => CBytes -> IO [(CBytes, DirEntType)] Source #
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.
Constructors
| FStat | |
Fields
| |
Instances
data UVTimeSpec Source #
Constructors
| UVTimeSpec | |
Fields
| |
Instances
rename :: HasCallStack => CBytes -> CBytes -> IO () Source #
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.
fdatasync :: HasCallStack => File -> IO () Source #
Equivalent to fdatasync(2).
ftruncate :: HasCallStack => File -> Int64 -> IO () Source #
Equivalent to ftruncate(2).
data CopyFileFlag where Source #
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.
Bundled Patterns
| pattern COPYFILE_DEFAULT :: CopyFileFlag | |
| pattern COPYFILE_EXCL :: CopyFileFlag | |
| pattern COPYFILE_FICLONE :: CopyFileFlag |
Instances
copyfile :: HasCallStack => CBytes -> CBytes -> CopyFileFlag -> IO () Source #
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.
data AccessMode where Source #
Bundled Patterns
| pattern F_OK :: AccessMode | |
| pattern R_OK :: AccessMode | |
| pattern W_OK :: AccessMode | |
| pattern X_OK :: AccessMode |
Instances
data AccessResult Source #
Constructors
| NoExistence | |
| NoPermission | |
| AccessOK |
Instances
access :: HasCallStack => CBytes -> AccessMode -> IO AccessResult Source #
Equivalent to access(2) on Unix. Windows uses GetFileAttributesW().
Arguments
| :: HasCallStack | |
| => CBytes | |
| -> Double | atime, i.e. access time |
| -> Double | mtime, i.e. modify time |
| -> IO () |
Arguments
| :: HasCallStack | |
| => CBytes | |
| -> Double | atime, i.e. access time |
| -> Double | mtime, i.e. modify time |
| -> IO () |
data SymlinkFlag where Source #
Bundled Patterns
| pattern SYMLINK_DEFAULT :: SymlinkFlag | |
| pattern SYMLINK_DIR :: SymlinkFlag | |
| pattern SYMLINK_JUNCTION :: SymlinkFlag |
Instances
symlink :: HasCallStack => CBytes -> CBytes -> SymlinkFlag -> IO () Source #
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.
readlink :: HasCallStack => CBytes -> IO CBytes Source #
Equivalent to readlink(2).
realpath :: HasCallStack => CBytes -> IO CBytes Source #
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.