Copyright	2018 Automattic Inc.
License	BSD3
Maintainer	Nathan Bloomfield (nbloomf@gmail.com)
Stability	experimental
Portability	POSIX
Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.MockIO.FileSystem

Description

A fake filesystem for testing.

Synopsis

data FileSystem a = FileSystem [File a]
data File a = File {
- _fileHandle :: a
- _fileContents :: [Text]
}
emptyFileSystem :: FileSystem a
fileExists :: Eq a => a -> FileSystem a -> Bool
hasFile :: Eq a => a -> [Text] -> FileSystem a -> Bool
deleteFile :: Eq a => a -> FileSystem a -> FileSystem a
getLines :: Eq a => a -> FileSystem a -> Maybe [Text]
writeLines :: Eq a => a -> [Text] -> FileSystem a -> FileSystem a
appendLines :: Eq a => a -> [Text] -> FileSystem a -> FileSystem a
readLine :: Eq a => e -> e -> a -> FileSystem a -> Either e (Text, FileSystem a)

Documentation

data FileSystem a Source #

A mapping from "handles" of type a to lists of lines.

Constructors

FileSystem [File a]

Instances

Instances details

Eq a => Eq (FileSystem a) Source #
Instance details Defined in Data.MockIO.FileSystem Methods (==) :: FileSystem a -> FileSystem a -> Bool # (/=) :: FileSystem a -> FileSystem a -> Bool #
Show a => Show (FileSystem a) Source #
Instance details Defined in Data.MockIO.FileSystem Methods showsPrec :: Int -> FileSystem a -> ShowS # show :: FileSystem a -> String # showList :: [FileSystem a] -> ShowS #
(Eq a, Arbitrary a) => Arbitrary (FileSystem a) Source #
Instance details Defined in Data.MockIO.FileSystem Methods arbitrary :: Gen (FileSystem a) # shrink :: FileSystem a -> [FileSystem a] #

data File a Source #

Abstraction of a text file consisting of a "handle" and a list of lines.

Constructors

File
Fields _fileHandle :: a File "handle" _fileContents :: [Text] List of lines

Instances

Instances details

Eq a => Eq (File a) Source #
Instance details Defined in Data.MockIO.FileSystem Methods (==) :: File a -> File a -> Bool # (/=) :: File a -> File a -> Bool #
Show a => Show (File a) Source #
Instance details Defined in Data.MockIO.FileSystem Methods showsPrec :: Int -> File a -> ShowS # show :: File a -> String # showList :: [File a] -> ShowS #

emptyFileSystem :: FileSystem a Source #

No files; populate with writeLines or appendLines.

fileExists Source #

Arguments

:: Eq a
=> a	File handle
-> FileSystem a
-> Bool

Detect whether a file with the given handle exists.

hasFile Source #

Arguments

:: Eq a
=> a	Handle
-> [Text]	Contents
-> FileSystem a
-> Bool

Detect whether a file with the given handle exists and has given contents.

deleteFile Source #

Arguments

:: Eq a
=> a	Handle
-> FileSystem a
-> FileSystem a

Delete a file; if no such file exists, has no effect.

getLines Source #

Arguments

:: Eq a
=> a	Handle
-> FileSystem a
-> Maybe [Text]

Retrieve the contents of a file, or nothing if the file does not exist.

writeLines Source #

Arguments

:: Eq a
=> a	Handle
-> [Text]	Contents
-> FileSystem a
-> FileSystem a

Overwrite the contents of a file.

appendLines Source #

Arguments

:: Eq a
=> a	Handle
-> [Text]	Contents
-> FileSystem a
-> FileSystem a

Append to a file.

readLine Source #

Arguments

:: Eq a
=> e	Handle not found error
-> e	EOF error
-> a	Handle
-> FileSystem a
-> Either e (Text, FileSystem a)

Read the first line of a file.