System.Path.IO

This module extends System.Path (which is re-exported for convenience) with thin wrappers around common IO functions and is intended to replace imports of System.FilePath,

To facilitate importing this module unqualified we also re-export some definitions from System.IO (importing both would likely lead to name clashes).

Wrappers

Wrappers around System.IO

withFile :: FsRoot root => Path root -> IOMode -> (Handle -> IO r) -> IO r

Wrapper around withFile

openTempFile' :: FsRoot root => Path root -> String -> IO (Path Absolute, Handle)

Wrapper around openBinaryTempFileWithDefaultPermissions

NOTE: The caller is responsible for cleaning up the temporary file.

Wrappers around Data.ByteString

readLazyByteString :: FsRoot root => Path root -> IO ByteString

Wrapper around lazy readFile

readStrictByteString :: FsRoot root => Path root -> IO ByteString

Wrapper around strict readFile

writeLazyByteString :: FsRoot root => Path root -> ByteString -> IO ()

Wrapper around lazy writeFile

writeStrictByteString :: FsRoot root => Path root -> ByteString -> IO ()

Wrapper around strict writeFile

appendLazyByteString :: FsRoot root => Path root -> ByteString -> IO ()

Wrapper around lazy appendFile

appendStrictByteString :: FsRoot root => Path root -> ByteString -> IO ()

Wrapper around strict appendFile

Wrappers around Data.Text.IO and Data.Text.Lazy.IO

Locale-dependent encoding

readLazyText :: FsRoot root => Path root -> IO Text

Wrapper around lazy readFile

readStrictText :: FsRoot root => Path root -> IO Text

Wrapper around strict readFile

writeLazyText :: FsRoot root => Path root -> Text -> IO ()

Wrapper around lazy writeFile

writeStrictText :: FsRoot root => Path root -> Text -> IO ()

Wrapper around strict writeFile

appendLazyText :: FsRoot root => Path root -> Text -> IO ()

Wrapper around lazy appendFile

appendStrictText :: FsRoot root => Path root -> Text -> IO ()

Wrapper around strict appendFile

UTF-8 encoding

readLazyTextUtf8 :: FsRoot root => Path root -> IO Text

Read lazy Text from a file (using UTF-8 encoding).

NOTE: Since the file is read lazily UTF-8 decoding errors are detected lazily as well. Such errors will result in an UnicodeException being thrown within the lazy Text stream.

readStrictTextUtf8 :: FsRoot root => Path root -> IO Text

Read strict Text from a file (using UTF-8 encoding).

NOTE: In case of UTF-8 decoding errors an UnicodeException will be thrown.

writeLazyTextUtf8 :: FsRoot root => Path root -> Text -> IO ()

Write lazy Text to a file (using UTF-8 encoding). The file is truncated to zero length before writing begins.

writeStrictTextUtf8 :: FsRoot root => Path root -> Text -> IO ()

Write strict Text to a file (using UTF-8 encoding). The file is truncated to zero length before writing begins.

appendLazyTextUtf8 :: FsRoot root => Path root -> Text -> IO ()

Append lazy Text to end of a file (using UTF-8 encoding).

appendStrictTextUtf8 :: FsRoot root => Path root -> Text -> IO ()

Append strict Text to end of a file (using UTF-8 encoding).

Wrappers around System.Directory

copyFile :: (FsRoot root, FsRoot root') => Path root -> Path root' -> IO ()

createDirectory :: FsRoot root => Path root -> IO ()

createDirectoryIfMissing :: FsRoot root => Bool -> Path root -> IO ()

removeDirectory :: FsRoot root => Path root -> IO ()

doesFileExist :: FsRoot root => Path root -> IO Bool

doesDirectoryExist :: FsRoot root => Path root -> IO Bool

getModificationTime :: FsRoot root => Path root -> IO UTCTime

removeFile :: FsRoot root => Path root -> IO ()

getTemporaryDirectory :: IO (Path Absolute)

getDirectoryContents :: FsRoot root => Path root -> IO [Path Unrooted]

Return the immediate children of a directory

Filters out "." and "..".

getRecursiveContents :: FsRoot root => Path root -> IO [Path Unrooted]

Recursive traverse a directory structure

Returns a set of paths relative to the directory specified. The list is lazily constructed, so that directories are only read when required. (This is also essential to ensure that this function does not build the entire result in memory before returning, potentially running out of heap.)

renameFile

Arguments

:: (FsRoot root, FsRoot root')

=> Path root

Old

-> Path root'

New

-> IO ()

getCurrentDirectory :: IO (Path Absolute)

Re-exports

Re-exported System.Path module

module System.Path

System.IO re-exports

data IOMode :: *

See openFile

Constructors

ReadMode

WriteMode

AppendMode

ReadWriteMode

Instances

Enum IOMode

Methods

succ :: IOMode -> IOMode

pred :: IOMode -> IOMode

toEnum :: Int -> IOMode

fromEnum :: IOMode -> Int

enumFrom :: IOMode -> [IOMode]

enumFromThen :: IOMode -> IOMode -> [IOMode]

enumFromTo :: IOMode -> IOMode -> [IOMode]

enumFromThenTo :: IOMode -> IOMode -> IOMode -> [IOMode]

Eq IOMode

Methods

(==) :: IOMode -> IOMode -> Bool

(/=) :: IOMode -> IOMode -> Bool

Ord IOMode

Methods

compare :: IOMode -> IOMode -> Ordering

(<) :: IOMode -> IOMode -> Bool

(<=) :: IOMode -> IOMode -> Bool

(>) :: IOMode -> IOMode -> Bool

(>=) :: IOMode -> IOMode -> Bool

max :: IOMode -> IOMode -> IOMode

min :: IOMode -> IOMode -> IOMode

Read IOMode

Methods

readsPrec :: Int -> ReadS IOMode

readList :: ReadS [IOMode]

readPrec :: ReadPrec IOMode

readListPrec :: ReadPrec [IOMode]

Show IOMode

Methods

showsPrec :: Int -> IOMode -> ShowS

show :: IOMode -> String

showList :: [IOMode] -> ShowS

Ix IOMode

Methods

range :: (IOMode, IOMode) -> [IOMode]

index :: (IOMode, IOMode) -> IOMode -> Int

unsafeIndex :: (IOMode, IOMode) -> IOMode -> Int

inRange :: (IOMode, IOMode) -> IOMode -> Bool

rangeSize :: (IOMode, IOMode) -> Int

unsafeRangeSize :: (IOMode, IOMode) -> Int

data BufferMode :: *

Three kinds of buffering are supported: line-buffering, block-buffering or no-buffering. These modes have the following effects. For output, items are written out, or flushed, from the internal buffer according to the buffer mode:

• line-buffering: the entire output buffer is flushed whenever a newline is output, the buffer overflows, a hFlush is issued, or the handle is closed.
• block-buffering: the entire buffer is written out whenever it overflows, a hFlush is issued, or the handle is closed.
• no-buffering: output is written immediately, and never stored in the buffer.

An implementation is free to flush the buffer more frequently, but not less frequently, than specified above. The output buffer is emptied as soon as it has been written out.

Similarly, input occurs according to the buffer mode for the handle:

• line-buffering: when the buffer for the handle is not empty, the next item is obtained from the buffer; otherwise, when the buffer is empty, characters up to and including the next newline character are read into the buffer. No characters are available until the newline character is available or the buffer is full.
• block-buffering: when the buffer for the handle becomes empty, the next block of data is read into the buffer.
• no-buffering: the next input item is read and returned. The hLookAhead operation implies that even a no-buffered handle may require a one-character buffer.

The default buffering mode when a handle is opened is implementation-dependent and may depend on the file system object which is attached to that handle. For most implementations, physical files will normally be block-buffered and terminals will normally be line-buffered.

Constructors

NoBuffering

buffering is disabled if possible.

LineBuffering

line-buffering should be enabled if possible.

BlockBuffering (Maybe Int)

block-buffering should be enabled if possible. The size of the buffer is n items if the argument is Just n and is otherwise implementation-dependent.

Instances

Eq BufferMode

Methods

(==) :: BufferMode -> BufferMode -> Bool

(/=) :: BufferMode -> BufferMode -> Bool

Ord BufferMode

Methods

compare :: BufferMode -> BufferMode -> Ordering

(<) :: BufferMode -> BufferMode -> Bool

(<=) :: BufferMode -> BufferMode -> Bool

(>) :: BufferMode -> BufferMode -> Bool

(>=) :: BufferMode -> BufferMode -> Bool

max :: BufferMode -> BufferMode -> BufferMode

min :: BufferMode -> BufferMode -> BufferMode

Read BufferMode

Methods

readsPrec :: Int -> ReadS BufferMode

readList :: ReadS [BufferMode]

readPrec :: ReadPrec BufferMode

readListPrec :: ReadPrec [BufferMode]

Show BufferMode

Methods

showsPrec :: Int -> BufferMode -> ShowS

show :: BufferMode -> String

showList :: [BufferMode] -> ShowS

data Handle :: *

Haskell defines operations to read and write characters from and to files, represented by values of type Handle. Each value of this type is a handle: a record used by the Haskell run-time system to manage I/O with file system objects. A handle has at least the following properties:

• whether it manages input or output or both;
• whether it is open, closed or semi-closed;
• whether the object is seekable;
• whether buffering is disabled, or enabled on a line or block basis;
• a buffer (whose length may be zero).

Most handles will also have a current I/O position indicating where the next input or output operation will occur. A handle is readable if it manages only input or both input and output; likewise, it is writable if it manages only output or both input and output. A handle is open when first allocated. Once it is closed it can no longer be used for either input or output, though an implementation cannot re-use its storage while references remain to it. Handles are in the Show and Eq classes. The string produced by showing a handle is system dependent; it should include enough information to identify the handle for debugging. A handle is equal according to == only to itself; no attempt is made to compare the internal state of different handles for equality.

Instances

Eq Handle

Since: 4.1.0.0

Methods

(==) :: Handle -> Handle -> Bool

(/=) :: Handle -> Handle -> Bool

Show Handle

Since: 4.1.0.0

Methods

showsPrec :: Int -> Handle -> ShowS

show :: Handle -> String

showList :: [Handle] -> ShowS

data SeekMode :: *

A mode that determines the effect of hSeek hdl mode i.

Constructors

AbsoluteSeek

the position of hdl is set to i.

RelativeSeek

the position of hdl is set to offset i from the current position.

SeekFromEnd

the position of hdl is set to offset i from the end of the file.

Instances

Enum SeekMode

Methods

succ :: SeekMode -> SeekMode

pred :: SeekMode -> SeekMode

toEnum :: Int -> SeekMode

fromEnum :: SeekMode -> Int

enumFrom :: SeekMode -> [SeekMode]

enumFromThen :: SeekMode -> SeekMode -> [SeekMode]

enumFromTo :: SeekMode -> SeekMode -> [SeekMode]

enumFromThenTo :: SeekMode -> SeekMode -> SeekMode -> [SeekMode]

Eq SeekMode

Methods

(==) :: SeekMode -> SeekMode -> Bool

(/=) :: SeekMode -> SeekMode -> Bool

Ord SeekMode

Methods

compare :: SeekMode -> SeekMode -> Ordering

(<) :: SeekMode -> SeekMode -> Bool

(<=) :: SeekMode -> SeekMode -> Bool

(>) :: SeekMode -> SeekMode -> Bool

(>=) :: SeekMode -> SeekMode -> Bool

max :: SeekMode -> SeekMode -> SeekMode

min :: SeekMode -> SeekMode -> SeekMode

Read SeekMode

Methods

readsPrec :: Int -> ReadS SeekMode

readList :: ReadS [SeekMode]

readPrec :: ReadPrec SeekMode

readListPrec :: ReadPrec [SeekMode]

Show SeekMode

Methods

showsPrec :: Int -> SeekMode -> ShowS

show :: SeekMode -> String

showList :: [SeekMode] -> ShowS

Ix SeekMode

Methods

range :: (SeekMode, SeekMode) -> [SeekMode]

index :: (SeekMode, SeekMode) -> SeekMode -> Int

unsafeIndex :: (SeekMode, SeekMode) -> SeekMode -> Int

inRange :: (SeekMode, SeekMode) -> SeekMode -> Bool

rangeSize :: (SeekMode, SeekMode) -> Int

unsafeRangeSize :: (SeekMode, SeekMode) -> Int

hSetBuffering :: Handle -> BufferMode -> IO ()

Computation hSetBuffering hdl mode sets the mode of buffering for handle hdl on subsequent reads and writes.

If the buffer mode is changed from BlockBuffering or LineBuffering to NoBuffering, then

• if hdl is writable, the buffer is flushed as for hFlush;
• if hdl is not writable, the contents of the buffer is discarded.

This operation may fail with:

• isPermissionError if the handle has already been used for reading or writing and the implementation does not allow the buffering mode to be changed.

hClose :: Handle -> IO ()

Computation hClose hdl makes handle hdl closed. Before the computation finishes, if hdl is writable its buffer is flushed as for hFlush. Performing hClose on a handle that has already been closed has no effect; doing so is not an error. All other operations on a closed handle will fail. If hClose fails for any reason, any further operations (apart from hClose) on the handle will still fail as if hdl had been successfully closed.

hFileSize :: Handle -> IO Integer

For a handle hdl which attached to a physical file, hFileSize hdl returns the size of that file in 8-bit bytes.

hSeek :: Handle -> SeekMode -> Integer -> IO ()

Computation hSeek hdl mode i sets the position of handle hdl depending on mode. The offset i is given in terms of 8-bit bytes.

If hdl is block- or line-buffered, then seeking to a position which is not in the current buffer will first cause any items in the output buffer to be written to the device, and then cause the input buffer to be discarded. Some handles may not be seekable (see hIsSeekable), or only support a subset of the possible positioning operations (for instance, it may only be possible to seek to the end of a tape, or to a positive offset from the beginning or current position). It is not possible to set a negative I/O position, or for a physical file, an I/O position beyond the current end-of-file.

This operation may fail with:

• isIllegalOperationError if the Handle is not seekable, or does not support the requested seek mode.
• isPermissionError if a system resource limit would be exceeded.