System.File

Simple FilePath‐aware wrappers around standard System.IO computations. See the linked documentation for each computation for details on exceptions and operating system interaction.

Documentation

type Handle = Handle

Re‐exported for convenience.

type Mode = IOMode

Re‐exported for convenience.

Binary files

openFile :: FilePath -> Mode -> IO Handle

Open a file in binary mode, and return an open Handle. The Handle should be hClosed when it is no longer needed.

withFile is easier to use, because it will handle the Handle’s lifetime automatically.

See: openBinaryFile

withFile :: FilePath -> Mode -> (Handle -> IO a) -> IO a

Open a file in binary mode, and pass its Handle to a provided computation. The Handle will be automatically closed when the computation returns.

See: withBinaryFile

readFile :: FilePath -> IO ByteString

Read in the entire contents of a binary file.

See: readFile

writeFile :: FilePath -> ByteString -> IO ()

Replace the entire contents of a binary file with the provided ByteString.

See: writeFile

appendFile :: FilePath -> ByteString -> IO ()

Append a ByteString to a file. If the file does not exist, it will be created.

See: appendFile

Text files

openTextFile :: FilePath -> Mode -> IO Handle

Open a file in text mode, and return an open Handle. The Handle should be hClosed when it is no longer needed.

withTextFile is easier to use, because it will handle the Handle’s lifetime automatically.

See: openFile

withTextFile :: FilePath -> Mode -> (Handle -> IO a) -> IO a

Open a file in text mode, and pass its Handle to a provided computation. The Handle will be automatically closed when the computation returns.

See: withFile

readTextFile :: FilePath -> IO Text

Read in the entire contents of a text file.

See: readFile

writeTextFile :: FilePath -> Text -> IO ()

Replace the entire contents of a text file with the provided Text.

See: writeFile

appendTextFile :: FilePath -> Text -> IO ()

Append Text to a file. If the file does not exist, it will be created.

See: appendFile