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

Contents

regular file devices
opening constant
filesystem operations

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 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
- = DirEntUnknown
- | DirEntFile
- | DirEntDir
- | DirEntLink
- | DirEntFIFO
- | DirEntSocket
- | DirEntChar
- | DirEntBlock
scandir :: HasCallStack => CBytes -> IO [(CBytes, DirEntType)]
data UVStat = UVStat {
- stDev :: !Word64
- stMode :: !Word64
- stNlink :: !Word64
- stUid :: !Word64
- stGid :: !Word64
- stRdev :: !Word64
- stIno :: !Word64
- stSize :: !Word64
- stBlksize :: !Word64
- stBlocks :: !Word64
- stFlags :: !Word64
- stGen :: !Word64
- stAtim :: !UVTimeSpec
- stMtim :: !UVTimeSpec
- stCtim :: !UVTimeSpec
- stBirthtim :: !UVTimeSpec
}
data UVTimeSpec = UVTimeSpec {
- uvtSecond :: !CLong
- uvtNanoSecond :: !CLong
}
stat :: HasCallStack => CBytes -> IO UVStat
lstat :: HasCallStack => CBytes -> IO UVStat
fstat :: HasCallStack => File -> IO UVStat
rename :: HasCallStack => CBytes -> CBytes -> IO ()
fsync :: HasCallStack => File -> IO ()
fdatasync :: HasCallStack => File -> IO ()
ftruncate :: HasCallStack => File -> Int64 -> IO ()
data UVCopyFileFlag where
- pattern COPYFILE_DEFAULT :: UVCopyFileFlag
- pattern COPYFILE_EXCL :: UVCopyFileFlag
- pattern COPYFILE_FICLONE :: UVCopyFileFlag
copyfile :: HasCallStack => CBytes -> CBytes -> UVCopyFileFlag -> IO ()
data UVAccessMode where
- pattern F_OK :: UVAccessMode
- pattern R_OK :: UVAccessMode
- pattern W_OK :: UVAccessMode
- pattern X_OK :: UVAccessMode
data AccessResult
- = NoExistence
- | NoPermission
- | AccessOK
access :: HasCallStack => CBytes -> UVAccessMode -> IO AccessResult
chmod :: HasCallStack => CBytes -> FileMode -> IO ()
fchmod :: HasCallStack => File -> FileMode -> IO ()
utime :: HasCallStack => CBytes -> Double -> Double -> IO ()
futime :: HasCallStack => File -> Double -> Double -> IO ()
data UVSymlinkFlag where
- pattern SYMLINK_DEFAULT :: UVSymlinkFlag
- pattern SYMLINK_DIR :: UVSymlinkFlag
- pattern SYMLINK_JUNCTION :: UVSymlinkFlag
link :: HasCallStack => CBytes -> CBytes -> IO ()
symlink :: HasCallStack => CBytes -> CBytes -> UVSymlinkFlag -> IO ()
readlink :: HasCallStack => CBytes -> IO CBytes
realpath :: HasCallStack => CBytes -> IO CBytes

regular file devices

data File Source #

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

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 readFile / writeFile.

Instances

Instances details

Output File Source #
Instance details Defined in Z.IO.FileSystem Methods writeOutput :: File -> Ptr Word8 -> Int -> IO () Source #
Input File Source #
Instance details Defined in Z.IO.FileSystem Methods readInput :: File -> Ptr Word8 -> Int -> IO Int Source #

initFile Source #

Arguments

:: HasCallStack
=> CBytes
-> FileFlag	Opening flags, e.g. `O_CREAT` `.\|.` `O_RDWR`
-> FileMode	Sets the file mode (permission and sticky bits), but only if the file was created, see `DEFAULT_MODE`.
-> Resource File

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

Resource closing is thread safe, on some versions of OSX, repeatly open and close same file Resource may result in shared memory object error, use O_CREAT to avoid that.

readFile Source #

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.

writeFile Source #

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.

opening constant

data FileMode where Source #

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

Instances details

Eq FileMode Source #
Instance details Defined in Z.IO.UV.FFI Methods (==) :: FileMode -> FileMode -> Bool # (/=) :: FileMode -> FileMode -> Bool #
Num FileMode Source #
Instance details Defined in Z.IO.UV.FFI Methods (+) :: FileMode -> FileMode -> FileMode # (-) :: FileMode -> FileMode -> FileMode # (*) :: FileMode -> FileMode -> FileMode # negate :: FileMode -> FileMode # abs :: FileMode -> FileMode # signum :: FileMode -> FileMode # fromInteger :: Integer -> FileMode #
Ord FileMode Source #
Instance details Defined in Z.IO.UV.FFI Methods compare :: FileMode -> FileMode -> Ordering # (<) :: FileMode -> FileMode -> Bool # (<=) :: FileMode -> FileMode -> Bool # (>) :: FileMode -> FileMode -> Bool # (>=) :: FileMode -> FileMode -> Bool # max :: FileMode -> FileMode -> FileMode # min :: FileMode -> FileMode -> FileMode #
Read FileMode Source #
Instance details Defined in Z.IO.UV.FFI Methods readsPrec :: Int -> ReadS FileMode # readList :: ReadS [FileMode] # readPrec :: ReadPrec FileMode # readListPrec :: ReadPrec [FileMode] #
Show FileMode Source #
Instance details Defined in Z.IO.UV.FFI Methods showsPrec :: Int -> FileMode -> ShowS # show :: FileMode -> String # showList :: [FileMode] -> ShowS #
Storable FileMode Source #
Instance details Defined in Z.IO.UV.FFI Methods sizeOf :: FileMode -> Int # alignment :: FileMode -> Int # peekElemOff :: Ptr FileMode -> Int -> IO FileMode # pokeElemOff :: Ptr FileMode -> Int -> FileMode -> IO () # peekByteOff :: Ptr b -> Int -> IO FileMode # pokeByteOff :: Ptr b -> Int -> FileMode -> IO () # peek :: Ptr FileMode -> IO FileMode # poke :: Ptr FileMode -> FileMode -> IO () #
Bits FileMode Source #
Instance details Defined in Z.IO.UV.FFI Methods (.&.) :: FileMode -> FileMode -> FileMode # (.\|.) :: FileMode -> FileMode -> FileMode # xor :: FileMode -> FileMode -> FileMode # complement :: FileMode -> FileMode # shift :: FileMode -> Int -> FileMode # rotate :: FileMode -> Int -> FileMode # zeroBits :: FileMode # bit :: Int -> FileMode # setBit :: FileMode -> Int -> FileMode # clearBit :: FileMode -> Int -> FileMode # complementBit :: FileMode -> Int -> FileMode # testBit :: FileMode -> Int -> Bool # bitSizeMaybe :: FileMode -> Maybe Int # bitSize :: FileMode -> Int # isSigned :: FileMode -> Bool # shiftL :: FileMode -> Int -> FileMode # unsafeShiftL :: FileMode -> Int -> FileMode # shiftR :: FileMode -> Int -> FileMode # unsafeShiftR :: FileMode -> Int -> FileMode # rotateL :: FileMode -> Int -> FileMode # rotateR :: FileMode -> Int -> FileMode # popCount :: FileMode -> Int #
FiniteBits FileMode Source #
Instance details Defined in Z.IO.UV.FFI Methods finiteBitSize :: FileMode -> Int # countLeadingZeros :: FileMode -> Int # countTrailingZeros :: FileMode -> Int #

data FileFlag where Source #

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 `BufferedIO`)
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 `o_DSYNC` is supported on Windows via `FILE_FLAG_WRITE_THROUGH`.
pattern O_EXCL :: FileFlag	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`.
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 `o_NOATIME` is not supported on Windows.
pattern O_NOFOLLOW :: FileFlag	If the path is a symbolic link, fail the open. Note `o_NOFOLLOW` is not supported on Windows.
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 `o_SYNC` is supported on Windows via `FILE_FLAG_WRITE_THROUGH`.
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 `o_RANDOM` is only supported on Windows via `FILE_FLAG_RANDOM_ACCESS`.
pattern O_SHORT_LIVED :: FileFlag	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`.
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 `o_SEQUENTIAL` is only supported on Windows via `FILE_FLAG_SEQUENTIAL_SCAN`.
pattern O_TEMPORARY :: FileFlag	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`.

Instances

Instances details

Eq FileFlag Source #
Instance details Defined in Z.IO.UV.FFI Methods (==) :: FileFlag -> FileFlag -> Bool # (/=) :: FileFlag -> FileFlag -> Bool #
Num FileFlag Source #
Instance details Defined in Z.IO.UV.FFI Methods (+) :: FileFlag -> FileFlag -> FileFlag # (-) :: FileFlag -> FileFlag -> FileFlag # (*) :: FileFlag -> FileFlag -> FileFlag # negate :: FileFlag -> FileFlag # abs :: FileFlag -> FileFlag # signum :: FileFlag -> FileFlag # fromInteger :: Integer -> FileFlag #
Ord FileFlag Source #
Instance details Defined in Z.IO.UV.FFI Methods compare :: FileFlag -> FileFlag -> Ordering # (<) :: FileFlag -> FileFlag -> Bool # (<=) :: FileFlag -> FileFlag -> Bool # (>) :: FileFlag -> FileFlag -> Bool # (>=) :: FileFlag -> FileFlag -> Bool # max :: FileFlag -> FileFlag -> FileFlag # min :: FileFlag -> FileFlag -> FileFlag #
Read FileFlag Source #
Instance details Defined in Z.IO.UV.FFI Methods readsPrec :: Int -> ReadS FileFlag # readList :: ReadS [FileFlag] # readPrec :: ReadPrec FileFlag # readListPrec :: ReadPrec [FileFlag] #
Show FileFlag Source #
Instance details Defined in Z.IO.UV.FFI Methods showsPrec :: Int -> FileFlag -> ShowS # show :: FileFlag -> String # showList :: [FileFlag] -> ShowS #
Storable FileFlag Source #
Instance details Defined in Z.IO.UV.FFI Methods sizeOf :: FileFlag -> Int # alignment :: FileFlag -> Int # peekElemOff :: Ptr FileFlag -> Int -> IO FileFlag # pokeElemOff :: Ptr FileFlag -> Int -> FileFlag -> IO () # peekByteOff :: Ptr b -> Int -> IO FileFlag # pokeByteOff :: Ptr b -> Int -> FileFlag -> IO () # peek :: Ptr FileFlag -> IO FileFlag # poke :: Ptr FileFlag -> FileFlag -> IO () #
Bits FileFlag Source #
Instance details Defined in Z.IO.UV.FFI Methods (.&.) :: FileFlag -> FileFlag -> FileFlag # (.\|.) :: FileFlag -> FileFlag -> FileFlag # xor :: FileFlag -> FileFlag -> FileFlag # complement :: FileFlag -> FileFlag # shift :: FileFlag -> Int -> FileFlag # rotate :: FileFlag -> Int -> FileFlag # zeroBits :: FileFlag # bit :: Int -> FileFlag # setBit :: FileFlag -> Int -> FileFlag # clearBit :: FileFlag -> Int -> FileFlag # complementBit :: FileFlag -> Int -> FileFlag # testBit :: FileFlag -> Int -> Bool # bitSizeMaybe :: FileFlag -> Maybe Int # bitSize :: FileFlag -> Int # isSigned :: FileFlag -> Bool # shiftL :: FileFlag -> Int -> FileFlag # unsafeShiftL :: FileFlag -> Int -> FileFlag # shiftR :: FileFlag -> Int -> FileFlag # unsafeShiftR :: FileFlag -> Int -> FileFlag # rotateL :: FileFlag -> Int -> FileFlag # rotateR :: FileFlag -> Int -> FileFlag # popCount :: FileFlag -> Int #
FiniteBits FileFlag Source #
Instance details Defined in Z.IO.UV.FFI Methods finiteBitSize :: FileFlag -> Int # countLeadingZeros :: FileFlag -> Int # countTrailingZeros :: FileFlag -> Int #

filesystem operations

mkdir :: HasCallStack => CBytes -> FileMode -> IO () Source #

Equivalent to mkdir(2).

Note mode is currently not implemented on Windows.

unlink :: HasCallStack => CBytes -> IO () Source #

Equivalent to unlink(2).

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.

rmdir :: HasCallStack => CBytes -> IO () Source #

Equivalent to rmdir(2).

data DirEntType Source #

Constructors

DirEntUnknown
DirEntFile
DirEntDir
DirEntLink
DirEntFIFO
DirEntSocket
DirEntChar
DirEntBlock

Instances

Instances details

Eq DirEntType Source #
Instance details Defined in Z.IO.UV.FFI Methods (==) :: DirEntType -> DirEntType -> Bool # (/=) :: DirEntType -> DirEntType -> Bool #
Ord DirEntType Source #
Instance details Defined in Z.IO.UV.FFI Methods compare :: DirEntType -> DirEntType -> Ordering # (<) :: DirEntType -> DirEntType -> Bool # (<=) :: DirEntType -> DirEntType -> Bool # (>) :: DirEntType -> DirEntType -> Bool # (>=) :: DirEntType -> DirEntType -> Bool # max :: DirEntType -> DirEntType -> DirEntType # min :: DirEntType -> DirEntType -> DirEntType #
Read DirEntType Source #
Instance details Defined in Z.IO.UV.FFI Methods readsPrec :: Int -> ReadS DirEntType # readList :: ReadS [DirEntType] # readPrec :: ReadPrec DirEntType # readListPrec :: ReadPrec [DirEntType] #
Show DirEntType Source #
Instance details Defined in Z.IO.UV.FFI Methods showsPrec :: Int -> DirEntType -> ShowS # show :: DirEntType -> String # showList :: [DirEntType] -> ShowS #
Generic DirEntType Source #
Instance details Defined in Z.IO.UV.FFI Associated Types type Rep DirEntType :: Type -> Type # Methods from :: DirEntType -> Rep DirEntType x # to :: Rep DirEntType x -> DirEntType #
type Rep DirEntType Source #
Instance details Defined in Z.IO.UV.FFI type Rep DirEntType = D1 ('MetaData "DirEntType" "Z.IO.UV.FFI" "Z-IO-0.1.1.1-inplace" 'False) (((C1 ('MetaCons "DirEntUnknown" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DirEntFile" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "DirEntDir" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DirEntLink" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "DirEntFIFO" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DirEntSocket" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "DirEntChar" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DirEntBlock" 'PrefixI 'False) (U1 :: Type -> Type))))

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.

data UVStat Source #

Constructors

UVStat
Fields stDev :: !Word64 stMode :: !Word64 stNlink :: !Word64 stUid :: !Word64 stGid :: !Word64 stRdev :: !Word64 stIno :: !Word64 stSize :: !Word64 stBlksize :: !Word64 stBlocks :: !Word64 stFlags :: !Word64 stGen :: !Word64 stAtim :: !UVTimeSpec stMtim :: !UVTimeSpec stCtim :: !UVTimeSpec stBirthtim :: !UVTimeSpec

Instances

Instances details

Eq UVStat Source #
Instance details Defined in Z.IO.UV.FFI Methods (==) :: UVStat -> UVStat -> Bool # (/=) :: UVStat -> UVStat -> Bool #
Ord UVStat Source #
Instance details Defined in Z.IO.UV.FFI Methods compare :: UVStat -> UVStat -> Ordering # (<) :: UVStat -> UVStat -> Bool # (<=) :: UVStat -> UVStat -> Bool # (>) :: UVStat -> UVStat -> Bool # (>=) :: UVStat -> UVStat -> Bool # max :: UVStat -> UVStat -> UVStat # min :: UVStat -> UVStat -> UVStat #
Read UVStat Source #
Instance details Defined in Z.IO.UV.FFI Methods readsPrec :: Int -> ReadS UVStat # readList :: ReadS [UVStat] # readPrec :: ReadPrec UVStat # readListPrec :: ReadPrec [UVStat] #
Show UVStat Source #
Instance details Defined in Z.IO.UV.FFI Methods showsPrec :: Int -> UVStat -> ShowS # show :: UVStat -> String # showList :: [UVStat] -> ShowS #
Generic UVStat Source #
Instance details Defined in Z.IO.UV.FFI Associated Types type Rep UVStat :: Type -> Type # Methods from :: UVStat -> Rep UVStat x # to :: Rep UVStat x -> UVStat #
type Rep UVStat Source #
Instance details Defined in Z.IO.UV.FFI type Rep UVStat = D1 ('MetaData "UVStat" "Z.IO.UV.FFI" "Z-IO-0.1.1.1-inplace" 'False) (C1 ('MetaCons "UVStat" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "stDev") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64) :: S1 ('MetaSel ('Just "stMode") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64)) :: (S1 ('MetaSel ('Just "stNlink") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64) :: S1 ('MetaSel ('Just "stUid") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64))) :: ((S1 ('MetaSel ('Just "stGid") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64) :: S1 ('MetaSel ('Just "stRdev") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64)) :: (S1 ('MetaSel ('Just "stIno") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64) :: S1 ('MetaSel ('Just "stSize") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64)))) :: (((S1 ('MetaSel ('Just "stBlksize") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64) :: S1 ('MetaSel ('Just "stBlocks") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64)) :: (S1 ('MetaSel ('Just "stFlags") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64) :: S1 ('MetaSel ('Just "stGen") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word64))) :: ((S1 ('MetaSel ('Just "stAtim") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 UVTimeSpec) :: S1 ('MetaSel ('Just "stMtim") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 UVTimeSpec)) :: (S1 ('MetaSel ('Just "stCtim") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 UVTimeSpec) :*: S1 ('MetaSel ('Just "stBirthtim") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 UVTimeSpec))))))

data UVTimeSpec Source #

Constructors

UVTimeSpec
Fields uvtSecond :: !CLong uvtNanoSecond :: !CLong

Instances

Instances details

Eq UVTimeSpec Source #
Instance details Defined in Z.IO.UV.FFI Methods (==) :: UVTimeSpec -> UVTimeSpec -> Bool # (/=) :: UVTimeSpec -> UVTimeSpec -> Bool #
Ord UVTimeSpec Source #
Instance details Defined in Z.IO.UV.FFI Methods compare :: UVTimeSpec -> UVTimeSpec -> Ordering # (<) :: UVTimeSpec -> UVTimeSpec -> Bool # (<=) :: UVTimeSpec -> UVTimeSpec -> Bool # (>) :: UVTimeSpec -> UVTimeSpec -> Bool # (>=) :: UVTimeSpec -> UVTimeSpec -> Bool # max :: UVTimeSpec -> UVTimeSpec -> UVTimeSpec # min :: UVTimeSpec -> UVTimeSpec -> UVTimeSpec #
Read UVTimeSpec Source #
Instance details Defined in Z.IO.UV.FFI Methods readsPrec :: Int -> ReadS UVTimeSpec # readList :: ReadS [UVTimeSpec] # readPrec :: ReadPrec UVTimeSpec # readListPrec :: ReadPrec [UVTimeSpec] #
Show UVTimeSpec Source #
Instance details Defined in Z.IO.UV.FFI Methods showsPrec :: Int -> UVTimeSpec -> ShowS # show :: UVTimeSpec -> String # showList :: [UVTimeSpec] -> ShowS #
Generic UVTimeSpec Source #
Instance details Defined in Z.IO.UV.FFI Associated Types type Rep UVTimeSpec :: Type -> Type # Methods from :: UVTimeSpec -> Rep UVTimeSpec x # to :: Rep UVTimeSpec x -> UVTimeSpec #
Storable UVTimeSpec Source #
Instance details Defined in Z.IO.UV.FFI Methods sizeOf :: UVTimeSpec -> Int # alignment :: UVTimeSpec -> Int # peekElemOff :: Ptr UVTimeSpec -> Int -> IO UVTimeSpec # pokeElemOff :: Ptr UVTimeSpec -> Int -> UVTimeSpec -> IO () # peekByteOff :: Ptr b -> Int -> IO UVTimeSpec # pokeByteOff :: Ptr b -> Int -> UVTimeSpec -> IO () # peek :: Ptr UVTimeSpec -> IO UVTimeSpec # poke :: Ptr UVTimeSpec -> UVTimeSpec -> IO () #
type Rep UVTimeSpec Source #
Instance details Defined in Z.IO.UV.FFI type Rep UVTimeSpec = D1 ('MetaData "UVTimeSpec" "Z.IO.UV.FFI" "Z-IO-0.1.1.1-inplace" 'False) (C1 ('MetaCons "UVTimeSpec" 'PrefixI 'True) (S1 ('MetaSel ('Just "uvtSecond") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 CLong) :*: S1 ('MetaSel ('Just "uvtNanoSecond") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 CLong)))

stat :: HasCallStack => CBytes -> IO UVStat Source #

Equivalent to stat(2)

lstat :: HasCallStack => CBytes -> IO UVStat Source #

Equivalent to lstat(2)

fstat :: HasCallStack => File -> IO UVStat Source #

Equivalent to fstat(2)

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.

fsync :: HasCallStack => File -> IO () Source #

Equivalent to fsync(2).

fdatasync :: HasCallStack => File -> IO () Source #

Equivalent to fdatasync(2).

ftruncate :: HasCallStack => File -> Int64 -> IO () Source #

Equivalent to ftruncate(2).

data UVCopyFileFlag 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 :: UVCopyFileFlag
pattern COPYFILE_EXCL :: UVCopyFileFlag
pattern COPYFILE_FICLONE :: UVCopyFileFlag

Instances

Instances details

Eq UVCopyFileFlag Source #
Instance details Defined in Z.IO.UV.FFI Methods (==) :: UVCopyFileFlag -> UVCopyFileFlag -> Bool # (/=) :: UVCopyFileFlag -> UVCopyFileFlag -> Bool #
Num UVCopyFileFlag Source #
Instance details Defined in Z.IO.UV.FFI Methods (+) :: UVCopyFileFlag -> UVCopyFileFlag -> UVCopyFileFlag # (-) :: UVCopyFileFlag -> UVCopyFileFlag -> UVCopyFileFlag # (*) :: UVCopyFileFlag -> UVCopyFileFlag -> UVCopyFileFlag # negate :: UVCopyFileFlag -> UVCopyFileFlag # abs :: UVCopyFileFlag -> UVCopyFileFlag # signum :: UVCopyFileFlag -> UVCopyFileFlag # fromInteger :: Integer -> UVCopyFileFlag #
Ord UVCopyFileFlag Source #
Instance details Defined in Z.IO.UV.FFI Methods compare :: UVCopyFileFlag -> UVCopyFileFlag -> Ordering # (<) :: UVCopyFileFlag -> UVCopyFileFlag -> Bool # (<=) :: UVCopyFileFlag -> UVCopyFileFlag -> Bool # (>) :: UVCopyFileFlag -> UVCopyFileFlag -> Bool # (>=) :: UVCopyFileFlag -> UVCopyFileFlag -> Bool # max :: UVCopyFileFlag -> UVCopyFileFlag -> UVCopyFileFlag # min :: UVCopyFileFlag -> UVCopyFileFlag -> UVCopyFileFlag #
Read UVCopyFileFlag Source #
Instance details Defined in Z.IO.UV.FFI Methods readsPrec :: Int -> ReadS UVCopyFileFlag # readList :: ReadS [UVCopyFileFlag] # readPrec :: ReadPrec UVCopyFileFlag # readListPrec :: ReadPrec [UVCopyFileFlag] #
Show UVCopyFileFlag Source #
Instance details Defined in Z.IO.UV.FFI Methods showsPrec :: Int -> UVCopyFileFlag -> ShowS # show :: UVCopyFileFlag -> String # showList :: [UVCopyFileFlag] -> ShowS #
Storable UVCopyFileFlag Source #
Instance details Defined in Z.IO.UV.FFI Methods sizeOf :: UVCopyFileFlag -> Int # alignment :: UVCopyFileFlag -> Int # peekElemOff :: Ptr UVCopyFileFlag -> Int -> IO UVCopyFileFlag # pokeElemOff :: Ptr UVCopyFileFlag -> Int -> UVCopyFileFlag -> IO () # peekByteOff :: Ptr b -> Int -> IO UVCopyFileFlag # pokeByteOff :: Ptr b -> Int -> UVCopyFileFlag -> IO () # peek :: Ptr UVCopyFileFlag -> IO UVCopyFileFlag # poke :: Ptr UVCopyFileFlag -> UVCopyFileFlag -> IO () #
Bits UVCopyFileFlag Source #
Instance details Defined in Z.IO.UV.FFI Methods (.&.) :: UVCopyFileFlag -> UVCopyFileFlag -> UVCopyFileFlag # (.\|.) :: UVCopyFileFlag -> UVCopyFileFlag -> UVCopyFileFlag # xor :: UVCopyFileFlag -> UVCopyFileFlag -> UVCopyFileFlag # complement :: UVCopyFileFlag -> UVCopyFileFlag # shift :: UVCopyFileFlag -> Int -> UVCopyFileFlag # rotate :: UVCopyFileFlag -> Int -> UVCopyFileFlag # zeroBits :: UVCopyFileFlag # bit :: Int -> UVCopyFileFlag # setBit :: UVCopyFileFlag -> Int -> UVCopyFileFlag # clearBit :: UVCopyFileFlag -> Int -> UVCopyFileFlag # complementBit :: UVCopyFileFlag -> Int -> UVCopyFileFlag # testBit :: UVCopyFileFlag -> Int -> Bool # bitSizeMaybe :: UVCopyFileFlag -> Maybe Int # bitSize :: UVCopyFileFlag -> Int # isSigned :: UVCopyFileFlag -> Bool # shiftL :: UVCopyFileFlag -> Int -> UVCopyFileFlag # unsafeShiftL :: UVCopyFileFlag -> Int -> UVCopyFileFlag # shiftR :: UVCopyFileFlag -> Int -> UVCopyFileFlag # unsafeShiftR :: UVCopyFileFlag -> Int -> UVCopyFileFlag # rotateL :: UVCopyFileFlag -> Int -> UVCopyFileFlag # rotateR :: UVCopyFileFlag -> Int -> UVCopyFileFlag # popCount :: UVCopyFileFlag -> Int #
FiniteBits UVCopyFileFlag Source #
Instance details Defined in Z.IO.UV.FFI Methods finiteBitSize :: UVCopyFileFlag -> Int # countLeadingZeros :: UVCopyFileFlag -> Int # countTrailingZeros :: UVCopyFileFlag -> Int #

copyfile :: HasCallStack => CBytes -> CBytes -> UVCopyFileFlag -> 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 UVAccessMode where Source #

Bundled Patterns

pattern F_OK :: UVAccessMode
pattern R_OK :: UVAccessMode
pattern W_OK :: UVAccessMode
pattern X_OK :: UVAccessMode

Instances

Instances details

Eq UVAccessMode Source #
Instance details Defined in Z.IO.UV.FFI Methods (==) :: UVAccessMode -> UVAccessMode -> Bool # (/=) :: UVAccessMode -> UVAccessMode -> Bool #
Num UVAccessMode Source #
Instance details Defined in Z.IO.UV.FFI Methods (+) :: UVAccessMode -> UVAccessMode -> UVAccessMode # (-) :: UVAccessMode -> UVAccessMode -> UVAccessMode # (*) :: UVAccessMode -> UVAccessMode -> UVAccessMode # negate :: UVAccessMode -> UVAccessMode # abs :: UVAccessMode -> UVAccessMode # signum :: UVAccessMode -> UVAccessMode # fromInteger :: Integer -> UVAccessMode #
Ord UVAccessMode Source #
Instance details Defined in Z.IO.UV.FFI Methods compare :: UVAccessMode -> UVAccessMode -> Ordering # (<) :: UVAccessMode -> UVAccessMode -> Bool # (<=) :: UVAccessMode -> UVAccessMode -> Bool # (>) :: UVAccessMode -> UVAccessMode -> Bool # (>=) :: UVAccessMode -> UVAccessMode -> Bool # max :: UVAccessMode -> UVAccessMode -> UVAccessMode # min :: UVAccessMode -> UVAccessMode -> UVAccessMode #
Read UVAccessMode Source #
Instance details Defined in Z.IO.UV.FFI Methods readsPrec :: Int -> ReadS UVAccessMode # readList :: ReadS [UVAccessMode] # readPrec :: ReadPrec UVAccessMode # readListPrec :: ReadPrec [UVAccessMode] #
Show UVAccessMode Source #
Instance details Defined in Z.IO.UV.FFI Methods showsPrec :: Int -> UVAccessMode -> ShowS # show :: UVAccessMode -> String # showList :: [UVAccessMode] -> ShowS #
Storable UVAccessMode Source #
Instance details Defined in Z.IO.UV.FFI Methods sizeOf :: UVAccessMode -> Int # alignment :: UVAccessMode -> Int # peekElemOff :: Ptr UVAccessMode -> Int -> IO UVAccessMode # pokeElemOff :: Ptr UVAccessMode -> Int -> UVAccessMode -> IO () # peekByteOff :: Ptr b -> Int -> IO UVAccessMode # pokeByteOff :: Ptr b -> Int -> UVAccessMode -> IO () # peek :: Ptr UVAccessMode -> IO UVAccessMode # poke :: Ptr UVAccessMode -> UVAccessMode -> IO () #
Bits UVAccessMode Source #
Instance details Defined in Z.IO.UV.FFI Methods (.&.) :: UVAccessMode -> UVAccessMode -> UVAccessMode # (.\|.) :: UVAccessMode -> UVAccessMode -> UVAccessMode # xor :: UVAccessMode -> UVAccessMode -> UVAccessMode # complement :: UVAccessMode -> UVAccessMode # shift :: UVAccessMode -> Int -> UVAccessMode # rotate :: UVAccessMode -> Int -> UVAccessMode # zeroBits :: UVAccessMode # bit :: Int -> UVAccessMode # setBit :: UVAccessMode -> Int -> UVAccessMode # clearBit :: UVAccessMode -> Int -> UVAccessMode # complementBit :: UVAccessMode -> Int -> UVAccessMode # testBit :: UVAccessMode -> Int -> Bool # bitSizeMaybe :: UVAccessMode -> Maybe Int # bitSize :: UVAccessMode -> Int # isSigned :: UVAccessMode -> Bool # shiftL :: UVAccessMode -> Int -> UVAccessMode # unsafeShiftL :: UVAccessMode -> Int -> UVAccessMode # shiftR :: UVAccessMode -> Int -> UVAccessMode # unsafeShiftR :: UVAccessMode -> Int -> UVAccessMode # rotateL :: UVAccessMode -> Int -> UVAccessMode # rotateR :: UVAccessMode -> Int -> UVAccessMode # popCount :: UVAccessMode -> Int #
FiniteBits UVAccessMode Source #
Instance details Defined in Z.IO.UV.FFI Methods finiteBitSize :: UVAccessMode -> Int # countLeadingZeros :: UVAccessMode -> Int # countTrailingZeros :: UVAccessMode -> Int #

data AccessResult Source #

Constructors

NoExistence
NoPermission
AccessOK

Instances

Instances details

Eq AccessResult Source #
Instance details Defined in Z.IO.UV.FFI Methods (==) :: AccessResult -> AccessResult -> Bool # (/=) :: AccessResult -> AccessResult -> Bool #
Ord AccessResult Source #
Instance details Defined in Z.IO.UV.FFI Methods compare :: AccessResult -> AccessResult -> Ordering # (<) :: AccessResult -> AccessResult -> Bool # (<=) :: AccessResult -> AccessResult -> Bool # (>) :: AccessResult -> AccessResult -> Bool # (>=) :: AccessResult -> AccessResult -> Bool # max :: AccessResult -> AccessResult -> AccessResult # min :: AccessResult -> AccessResult -> AccessResult #
Show AccessResult Source #
Instance details Defined in Z.IO.UV.FFI Methods showsPrec :: Int -> AccessResult -> ShowS # show :: AccessResult -> String # showList :: [AccessResult] -> ShowS #

access :: HasCallStack => CBytes -> UVAccessMode -> IO AccessResult Source #

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

chmod :: HasCallStack => CBytes -> FileMode -> IO () Source #

Equivalent to chmod(2).

fchmod :: HasCallStack => File -> FileMode -> IO () Source #

Equivalent to fchmod(2).

utime Source #

Arguments

:: HasCallStack
=> CBytes
-> Double	atime, i.e. access time
-> Double	mtime, i.e. modify time
-> IO ()

Equivalent to utime(2).

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

second = v
nanosecond = (v * 1000000) % 1000000 * 1000;

second and nanosecond are fields in UVTimeSpec respectively.

Note libuv prior to v1.23.1 have issues which may result in nanosecond not set, futime doesn't have that issue.

futime :: HasCallStack => File -> Double -> Double -> IO () Source #

Equivalent to futime(2).

Same precision notes with utime.

data UVSymlinkFlag where Source #

Bundled Patterns

pattern SYMLINK_DEFAULT :: UVSymlinkFlag
pattern SYMLINK_DIR :: UVSymlinkFlag
pattern SYMLINK_JUNCTION :: UVSymlinkFlag

Instances

Instances details

Eq UVSymlinkFlag Source #
Instance details Defined in Z.IO.UV.FFI Methods (==) :: UVSymlinkFlag -> UVSymlinkFlag -> Bool # (/=) :: UVSymlinkFlag -> UVSymlinkFlag -> Bool #
Num UVSymlinkFlag Source #
Instance details Defined in Z.IO.UV.FFI Methods (+) :: UVSymlinkFlag -> UVSymlinkFlag -> UVSymlinkFlag # (-) :: UVSymlinkFlag -> UVSymlinkFlag -> UVSymlinkFlag # (*) :: UVSymlinkFlag -> UVSymlinkFlag -> UVSymlinkFlag # negate :: UVSymlinkFlag -> UVSymlinkFlag # abs :: UVSymlinkFlag -> UVSymlinkFlag # signum :: UVSymlinkFlag -> UVSymlinkFlag # fromInteger :: Integer -> UVSymlinkFlag #
Ord UVSymlinkFlag Source #
Instance details Defined in Z.IO.UV.FFI Methods compare :: UVSymlinkFlag -> UVSymlinkFlag -> Ordering # (<) :: UVSymlinkFlag -> UVSymlinkFlag -> Bool # (<=) :: UVSymlinkFlag -> UVSymlinkFlag -> Bool # (>) :: UVSymlinkFlag -> UVSymlinkFlag -> Bool # (>=) :: UVSymlinkFlag -> UVSymlinkFlag -> Bool # max :: UVSymlinkFlag -> UVSymlinkFlag -> UVSymlinkFlag # min :: UVSymlinkFlag -> UVSymlinkFlag -> UVSymlinkFlag #
Read UVSymlinkFlag Source #
Instance details Defined in Z.IO.UV.FFI Methods readsPrec :: Int -> ReadS UVSymlinkFlag # readList :: ReadS [UVSymlinkFlag] # readPrec :: ReadPrec UVSymlinkFlag # readListPrec :: ReadPrec [UVSymlinkFlag] #
Show UVSymlinkFlag Source #
Instance details Defined in Z.IO.UV.FFI Methods showsPrec :: Int -> UVSymlinkFlag -> ShowS # show :: UVSymlinkFlag -> String # showList :: [UVSymlinkFlag] -> ShowS #
Storable UVSymlinkFlag Source #
Instance details Defined in Z.IO.UV.FFI Methods sizeOf :: UVSymlinkFlag -> Int # alignment :: UVSymlinkFlag -> Int # peekElemOff :: Ptr UVSymlinkFlag -> Int -> IO UVSymlinkFlag # pokeElemOff :: Ptr UVSymlinkFlag -> Int -> UVSymlinkFlag -> IO () # peekByteOff :: Ptr b -> Int -> IO UVSymlinkFlag # pokeByteOff :: Ptr b -> Int -> UVSymlinkFlag -> IO () # peek :: Ptr UVSymlinkFlag -> IO UVSymlinkFlag # poke :: Ptr UVSymlinkFlag -> UVSymlinkFlag -> IO () #
Bits UVSymlinkFlag Source #
Instance details Defined in Z.IO.UV.FFI Methods (.&.) :: UVSymlinkFlag -> UVSymlinkFlag -> UVSymlinkFlag # (.\|.) :: UVSymlinkFlag -> UVSymlinkFlag -> UVSymlinkFlag # xor :: UVSymlinkFlag -> UVSymlinkFlag -> UVSymlinkFlag # complement :: UVSymlinkFlag -> UVSymlinkFlag # shift :: UVSymlinkFlag -> Int -> UVSymlinkFlag # rotate :: UVSymlinkFlag -> Int -> UVSymlinkFlag # zeroBits :: UVSymlinkFlag # bit :: Int -> UVSymlinkFlag # setBit :: UVSymlinkFlag -> Int -> UVSymlinkFlag # clearBit :: UVSymlinkFlag -> Int -> UVSymlinkFlag # complementBit :: UVSymlinkFlag -> Int -> UVSymlinkFlag # testBit :: UVSymlinkFlag -> Int -> Bool # bitSizeMaybe :: UVSymlinkFlag -> Maybe Int # bitSize :: UVSymlinkFlag -> Int # isSigned :: UVSymlinkFlag -> Bool # shiftL :: UVSymlinkFlag -> Int -> UVSymlinkFlag # unsafeShiftL :: UVSymlinkFlag -> Int -> UVSymlinkFlag # shiftR :: UVSymlinkFlag -> Int -> UVSymlinkFlag # unsafeShiftR :: UVSymlinkFlag -> Int -> UVSymlinkFlag # rotateL :: UVSymlinkFlag -> Int -> UVSymlinkFlag # rotateR :: UVSymlinkFlag -> Int -> UVSymlinkFlag # popCount :: UVSymlinkFlag -> Int #
FiniteBits UVSymlinkFlag Source #
Instance details Defined in Z.IO.UV.FFI Methods finiteBitSize :: UVSymlinkFlag -> Int # countLeadingZeros :: UVSymlinkFlag -> Int # countTrailingZeros :: UVSymlinkFlag -> Int #

link :: HasCallStack => CBytes -> CBytes -> IO () Source #

Equivalent to link(2).

symlink :: HasCallStack => CBytes -> CBytes -> UVSymlinkFlag -> 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.