Modulefs-sim-0.5.0.1Haskell2010

System.FS.Sim.FsTree

Internal part of the mock file system

Intended for qualified import

import           System.FS.Sim.FsTree (FsTree)
import qualified System.FS.Sim.FsTree as FS

Contents

FsTree type and indexing functions
Construction
Indexing
File system operations
Path-listing
Pretty-printing

Synopsis

data FsTree
data FsTreeError
value example
value empty
value getDir
value getFile
value index
value createDirIfMissing
value createDirWithParents
value openFile
value removeDirRecursive
value removeFile
value renameFile
value replace
value find
value pretty

Packagefs-sim-0.5.0.1
Exports16
LanguageHaskell2010
LicenceApache-2.0
SourceFsTree.hs

FsTree type and indexing functions

datadata FsTree a

Source#

Simple in-memory representation of a file system

Constructors

File !a
Folder !(Folder a)

Instances5Functor, Eq, Show, Generic, Rep

Functor FsTreeDefined in fs-sim-0.5.0.1 · System.FS.Sim.FsTree
Eq a => Eq (FsTree a)Defined in fs-sim-0.5.0.1 · System.FS.Sim.FsTree
Show a => Show (FsTree a)Defined in fs-sim-0.5.0.1 · System.FS.Sim.FsTree
Generic (FsTree a)Defined in fs-sim-0.5.0.1 · System.FS.Sim.FsTree
type Rep (FsTree a) = D1 ('MetaData "FsTree" "System.FS.Sim.FsTree" "fs-sim-0.5.0.1-AMG23qT3NTsFrMOedWsD8M" 'False) (C1 ('MetaCons "File" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a)) :+: C1 ('MetaCons "Folder" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Folder a))))Defined in fs-sim-0.5.0.1 · System.FS.Sim.FsTree

datadata FsTreeError

Source#

File access error

Constructors

FsExpectedDir FsPath (NonEmpty Text)
A path ..a.. where a is a file rather than a dir
We record both the full path and the invalid suffix.
FsExpectedFile FsPath
A path ..a.. where a is a dir rather than a file
No suffix is specified (it must be the last part of the file)
FsMissing FsPath (NonEmpty Text)
A path ..a.. or ../a where directory or file a is missing
We record both the full path and the missing suffix.
FsExists FsPath
A file was opened with the O_EXCL flag, but it already existed.

Instances1Show

Show FsTreeErrorDefined in fs-sim-0.5.0.1 · System.FS.Sim.FsTree

valueexample :: Monoid a => FsTree a

Source#

Example

Construction

valueempty :: FsTree a

Indexing

valuegetDir :: FsPath -> FsTree a -> Either FsTreeError (Folder a)

valuegetFile :: FsPath -> FsTree a -> Either FsTreeError a

valueindex :: FsPath -> FsTree a -> Either FsTreeError (FsTree a)

Source#

Index the FsTree by the given FsPath.

File system operations

valuecreateDirIfMissing :: FsPath -> FsTree a -> Either FsTreeError (FsTree a)

Source#

Create a directory if it does not already exist

valuecreateDirWithParents :: FsPath -> FsTree a -> Either FsTreeError (FsTree a)

Source#

Create a directory and its parents if they do not already exist

valueopenFile

:: Monoid a
=> FsPath
-> AllowExisting
-> FsTree a
-> Either FsTreeError (FsTree a)

Source#

Open a file: create it if necessary or throw an error if either: 1. It existed already while we were supposed to create it from scratch (when passed MustBeNew). 2. It did not already exists when we expected to (when passed MustExist).

valueremoveDirRecursive :: FsPath -> FsTree a -> Either FsTreeError (FsTree a)

Source#

Remove a directory (which must exist) and its contents

valueremoveFile :: FsPath -> FsTree a -> Either FsTreeError (FsTree a)

Source#

Remove a file (which must exist)

valuerenameFile :: FsPath -> FsPath -> FsTree a -> Either FsTreeError (FsTree a)

Source#

Rename the file (which must exist) from the first path to the second path. If there is already a file at the latter path, it is replaced by the new one.

valuereplace :: FsPath -> a -> FsTree a -> Either FsTreeError (FsTree a)

Source#

Replace the contents of the specified file (which must exist)

Path-listing

valuefind :: FsPath -> FsTree a -> Either FsTreeError [FsPath]

Pretty-printing

valuepretty :: (a -> String) -> FsTree a -> String