the String in the name field is always a file name, never a full path. The free type variable is used in the File constructor and can hold Handles, Strings representing a file's contents or anything else you can think of. We catch any IO errors in the Failed constructor. an Exception can be converted to a String with show.

a simple wrapper to hold a base directory name, which can be either an absolute or relative path. This lets us give the DirTree a context, while still letting us store only directory and file names (not full paths) in the DirTree. (uses an infix constructor; don't be scared)

an element in a FilePath:

build an AnchoredDirTree, given the path to a directory, opening the files using readFile. Uses readDirectoryWith internally and has the effect of traversing the entire directory structure. See readDirectoryWithL for lazy production of a DirTree structure.

same as readDirectory but allows us to, for example, use ByteString.readFile to return a tree of ByteStrings.

A "lazy" version of readDirectoryWith that does IO operations as needed i.e. as the tree is traversed in pure code. NOTE: This function uses unsafePerformIO under the hood. I believe our use here is safe, but this function is experimental in this release:

write a DirTree of strings to disk. Clobbers files of the same name. Doesn't affect files in the directories (if any already exist) with different names. Returns a new AnchoredDirTree where failures were lifted into a Failed constructor:

writes the directory structure to disk and uses the provided function to write the contents of Files to disk. The return value of the function will become the new contents of the returned, where IO errors at each node are replaced with Failed constructors. The returned tree can be compared to the passed tree to see what operations, if any, failed:

builds a DirTree from the contents of the directory passed to it, saving the base directory in the Anchored* wrapper. Errors are caught in the tree in the Failed constructor. The file fields initially are populated with full paths to the files they are abstracting.

identical to build but does directory reading IO lazily as needed:

a simple application of readDirectoryWith openFile:

writes the directory structure (not files) of a DirTree to the anchored directory. Returns a structure identical to the supplied tree with errors replaced by Failed constructors:

tuple up the complete file path with the file contents, by building up the path, trie-style, from the root. The filepath will be relative to "anchored" directory.

This allows us to, for example, mapM_ uncurry writeFile over a DirTree of strings, although writeDirectory does a better job of this.

DEPRECATED. Use record dirTree instead.

Tests equality of two trees, ignoring their free variable portion. Can be used to check if any files have been added or deleted, for instance.

a compare function that ignores the free "file" type variable:

True if there are no Failed constructors in the tree

True if any Failed constructors in the tree

returns true if argument is a Failed constructor:

returns a list of Failed constructors only:

maps a function to convert Failed DirTrees to Files or Dirs

Flattens a DirTree into a (never empty) list of tree constructors. Dir constructors will have [] as their contents:

Recursively sort a directory tree according to the Ord instance

Recursively sort a tree as in sortDir but ignore the file contents of a File constructor

applies the predicate to each constructor in the tree, removing it (and its children, of course) when the predicate returns False. The topmost constructor will always be preserved:

If the argument is a Dir containing a sub-DirTree matching FileName then return that subtree, appending the name of the old root Dir to the anchor of the AnchoredDirTree wrapper. Otherwise return Nothing.

Allows for a function on a bare DirTree to be applied to an AnchoredDirTree within a Functor. Very similar to and useful in combination with <$>: