System.DirTree

A directory tree, with helper functions to do different cool stuff.

DirTree

newtype DirTree s a

A dir tree is a tree of nodes.

Constructors

DirTree

Fields

• dirTreeNode :: DirTreeN s a

Instances

FunctorWithIndex FileKey (DirTree v)

Defined in System.DirTree

Methods

imap :: (FileKey -> a -> b) -> DirTree v a -> DirTree v b

imapped :: IndexedSetter FileKey (DirTree v a) (DirTree v b) a b

FoldableWithIndex FileKey (DirTree v)

Defined in System.DirTree

Methods

ifoldMap :: Monoid m => (FileKey -> a -> m) -> DirTree v a -> m

ifolded :: IndexedFold FileKey (DirTree v a) a

ifoldr :: (FileKey -> a -> b -> b) -> b -> DirTree v a -> b

ifoldl :: (FileKey -> b -> a -> b) -> b -> DirTree v a -> b

ifoldr' :: (FileKey -> a -> b -> b) -> b -> DirTree v a -> b

ifoldl' :: (FileKey -> b -> a -> b) -> b -> DirTree v a -> b

TraversableWithIndex FileKey (DirTree v)

Defined in System.DirTree

Methods

itraverse :: Applicative f => (FileKey -> a -> f b) -> DirTree v a -> f (DirTree v b)

itraversed :: IndexedTraversal FileKey (DirTree v a) (DirTree v b) a b

Functor (DirTree s)

Defined in System.DirTree

Methods

fmap :: (a -> b) -> DirTree s a -> DirTree s b

(<$) :: a -> DirTree s b -> DirTree s a

(Show a, Show b) => Show (FileMap (DirTree a b))

Defined in System.DirTree

Methods

showsPrec :: Int -> FileMap (DirTree a b) -> ShowS

show :: FileMap (DirTree a b) -> String

showList :: [FileMap (DirTree a b)] -> ShowS

Foldable (DirTree s)

Defined in System.DirTree

Methods

fold :: Monoid m => DirTree s m -> m

foldMap :: Monoid m => (a -> m) -> DirTree s a -> m

foldr :: (a -> b -> b) -> b -> DirTree s a -> b

foldr' :: (a -> b -> b) -> b -> DirTree s a -> b

foldl :: (b -> a -> b) -> b -> DirTree s a -> b

foldl' :: (b -> a -> b) -> b -> DirTree s a -> b

foldr1 :: (a -> a -> a) -> DirTree s a -> a

foldl1 :: (a -> a -> a) -> DirTree s a -> a

toList :: DirTree s a -> [a]

null :: DirTree s a -> Bool

length :: DirTree s a -> Int

elem :: Eq a => a -> DirTree s a -> Bool

maximum :: Ord a => DirTree s a -> a

minimum :: Ord a => DirTree s a -> a

sum :: Num a => DirTree s a -> a

product :: Num a => DirTree s a -> a

Traversable (DirTree s)

Defined in System.DirTree

Methods

traverse :: Applicative f => (a -> f b) -> DirTree s a -> f (DirTree s b)

sequenceA :: Applicative f => DirTree s (f a) -> f (DirTree s a)

mapM :: Monad m => (a -> m b) -> DirTree s a -> m (DirTree s b)

sequence :: Monad m => DirTree s (m a) -> m (DirTree s a)

(Eq s, Eq a) => Eq (DirTree s a)

Defined in System.DirTree

Methods

(==) :: DirTree s a -> DirTree s a -> Bool

(/=) :: DirTree s a -> DirTree s a -> Bool

(Ord s, Ord a) => Ord (DirTree s a)

Defined in System.DirTree

Methods

compare :: DirTree s a -> DirTree s a -> Ordering

(<) :: DirTree s a -> DirTree s a -> Bool

(<=) :: DirTree s a -> DirTree s a -> Bool

(>) :: DirTree s a -> DirTree s a -> Bool

(>=) :: DirTree s a -> DirTree s a -> Bool

max :: DirTree s a -> DirTree s a -> DirTree s a

min :: DirTree s a -> DirTree s a -> DirTree s a

(Show v, Show c) => Show (DirTree v c)

Defined in System.DirTree

Methods

showsPrec :: Int -> DirTree v c -> ShowS

show :: DirTree v c -> String

showList :: [DirTree v c] -> ShowS

Generic (DirTree s a)

Defined in System.DirTree

Associated Types

type Rep (DirTree s a) :: Type -> Type

Methods

from :: DirTree s a -> Rep (DirTree s a) x

to :: Rep (DirTree s a) x -> DirTree s a

Semigroup (DirTree s a)

Defined in System.DirTree

Methods

(<>) :: DirTree s a -> DirTree s a -> DirTree s a

sconcat :: NonEmpty (DirTree s a) -> DirTree s a

stimes :: Integral b => b -> DirTree s a -> DirTree s a

(NFData s, NFData a) => NFData (DirTree s a)

Defined in System.DirTree

Methods

rnf :: DirTree s a -> ()

type Rep (DirTree s a)

Defined in System.DirTree

type Rep (DirTree s a) = D1 (MetaData "DirTree" "System.DirTree" "dirtree-0.0.1-LpN3AmmKCsNWVMG7Xg0uO" True) (C1 (MetaCons "DirTree" PrefixI True) (S1 (MetaSel (Just "dirTreeNode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (DirTreeN s a))))

file :: a -> DirTree s a

Constructs a dirtree with only a file

symlink :: s -> DirTree s a

Constructs a dirtree with a symlink

directory :: FileMap (DirTree s a) -> DirTree s a

Constructs a dirtree with a directory

directoryFromFiles :: [(String, DirTree s a)] -> DirTree s a

Constructs a dirtree with a directory

Constructors

fromFiles :: [(FileKey, Either v a)] -> Maybe (DirTree v a)

Create a dirtree from a non-empty list of files.

fromFiles' :: NonEmpty (FileKey, Either v a) -> DirTree v a

Create a dirtree from a non-empty list of files.

fromFile :: FileKey -> a -> DirTree Void a

toFiles :: DirTree v a -> [(FileKey, Either v a)]

Accessors

type FileKey = [String]

A filekey is the filepath in reverse order

fileKeyToPath :: FileKey -> FilePath

Get a FilePath from a FileKey

fileKeyFromPath :: FilePath -> FileKey

Get a FileKey from a FilePath

lookupFile :: FileKey -> DirTree v a -> Maybe (DirTree v a)

Lookup a file in a DirTree using a FileKey

Traversals

traverseDirTree :: Applicative f => (DirTreeNode (FileMap (f (DirTree s' a'))) s a -> f (DirTreeN s' a')) -> DirTree s a -> f (DirTree s' a')

Traverse a DirTree

traverseDirTree' :: Applicative m => (s -> m s') -> (a -> m a') -> DirTree s a -> m (DirTree s' a')

Traverse a DirTree

itraverseDirTree :: Applicative f => (FileKey -> DirTreeNode (FileMap (f (DirTree s' a'))) s a -> f (DirTreeN s' a')) -> DirTree s a -> f (DirTree s' a')

Traverse over the tree

itraverseDirTree' :: Applicative f => (FileKey -> s -> f s') -> (FileKey -> a -> f a') -> DirTree s a -> f (DirTree s' a')

Traverse over the tree with index. This method uses two functions one symlinks and one for files.

mapDirTree' :: (s -> s') -> (a -> a') -> DirTree s a -> DirTree s' a'

maps over a dirtree

imapDirTree' :: (FileKey -> s -> s') -> (FileKey -> a -> a') -> DirTree s a -> DirTree s' a'

Maps over a DirTree

depthfirst :: Monoid m => (FileKey -> DirTreeNode [String] v a -> m) -> DirTree v a -> m

Recursively iterate over a folder.

foldDirTree :: (DirTreeNode (FileMap m) s a -> m) -> DirTree s a -> m

Folds over a dirtree

foldDirTree' :: Monoid m => (s -> m) -> (a -> m) -> DirTree s a -> m

Folds over a dirtree

ifoldDirTree :: (FileKey -> DirTreeNode (FileMap m) s a -> m) -> DirTree s a -> m

Folds over a DirTree using the DirTreeNode.

ifoldDirTree' :: Monoid m => (FileKey -> s -> m) -> (FileKey -> a -> m) -> DirTree s a -> m

Folds over a DirTree.

flatten :: (s -> DirTree s' a') -> (a -> DirTree s' a') -> DirTree s a -> DirTree s' a'

Flatten a directory tree. This is usefull for following symlinks, or expanding zip-files.

Utils

findNode :: (FileKey -> DirTreeNode [String] v a -> Bool) -> DirTree v a -> Maybe (FileKey, DirTreeNode [String] v a)

Find a file given a predicate that takes a FileKey and DirTreeNode.

listNodes :: DirTree v a -> [(FileKey, DirTreeNode [String] v a)]

List all the nodes in the DirTree.

IO operations

readDirTree :: NFData a => (FilePath -> IO a) -> FilePath -> IO (DirTree Link a)

Reads a DirTree. All file paths are absolute to the filepath

lazyReadDirTree :: (FilePath -> IO a) -> FilePath -> IO (DirTree Link a)

Lazy read a DirTree. This function uses unsafeInterleaveIO to lazy interleave load a node. This means that it can be used to efficiently search of a file. All paths are absolute

writeDirTree :: (FilePath -> a -> IO ()) -> FilePath -> DirTree Link a -> IO ()

Reads a DirTree

followLinks :: NFData a => (FilePath -> IO a) -> DirTree Link a -> IO (DirTree Void a)

Follow the links to create the tree. This function might recurse forever.

lazyFollowLinks :: (FilePath -> IO a) -> DirTree Link a -> IO (DirTree Void a)

Like follow links but uses lazy io to only load the recursive folder when needed.

DirTreeNode

data Link

A Link can either be Internal, pointing to something in the DirTree or External pointing to an absolute FilePath.

Constructors

Internal !FileKey

External !FilePath

Instances

Eq Link

Defined in System.DirTree

Methods

(==) :: Link -> Link -> Bool

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

Show Link

Defined in System.DirTree

Methods

showsPrec :: Int -> Link -> ShowS

show :: Link -> String

showList :: [Link] -> ShowS

Generic Link

Defined in System.DirTree

Associated Types

type Rep Link :: Type -> Type

Methods

from :: Link -> Rep Link x

to :: Rep Link x -> Link

NFData Link

Defined in System.DirTree

Methods

rnf :: Link -> ()

type Rep Link

Defined in System.DirTree

type Rep Link = D1 (MetaData "Link" "System.DirTree" "dirtree-0.0.1-LpN3AmmKCsNWVMG7Xg0uO" False) (C1 (MetaCons "Internal" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 FileKey)) :+: C1 (MetaCons "External" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 FilePath)))

data DirTreeNode r s a

A directory tree node. Everything is either a file, a symbolic link, or a directory.

Constructors

Directory r

Symlink s

File a

Instances

Functor (DirTreeNode r s)

Defined in System.DirTree

Methods

fmap :: (a -> b) -> DirTreeNode r s a -> DirTreeNode r s b

(<$) :: a -> DirTreeNode r s b -> DirTreeNode r s a

Foldable (DirTreeNode r s)

Defined in System.DirTree

Methods

fold :: Monoid m => DirTreeNode r s m -> m

foldMap :: Monoid m => (a -> m) -> DirTreeNode r s a -> m

foldr :: (a -> b -> b) -> b -> DirTreeNode r s a -> b

foldr' :: (a -> b -> b) -> b -> DirTreeNode r s a -> b

foldl :: (b -> a -> b) -> b -> DirTreeNode r s a -> b

foldl' :: (b -> a -> b) -> b -> DirTreeNode r s a -> b

foldr1 :: (a -> a -> a) -> DirTreeNode r s a -> a

foldl1 :: (a -> a -> a) -> DirTreeNode r s a -> a

toList :: DirTreeNode r s a -> [a]

null :: DirTreeNode r s a -> Bool

length :: DirTreeNode r s a -> Int

elem :: Eq a => a -> DirTreeNode r s a -> Bool

maximum :: Ord a => DirTreeNode r s a -> a

minimum :: Ord a => DirTreeNode r s a -> a

sum :: Num a => DirTreeNode r s a -> a

product :: Num a => DirTreeNode r s a -> a

Traversable (DirTreeNode r s)

Defined in System.DirTree

Methods

traverse :: Applicative f => (a -> f b) -> DirTreeNode r s a -> f (DirTreeNode r s b)

sequenceA :: Applicative f => DirTreeNode r s (f a) -> f (DirTreeNode r s a)

mapM :: Monad m => (a -> m b) -> DirTreeNode r s a -> m (DirTreeNode r s b)

sequence :: Monad m => DirTreeNode r s (m a) -> m (DirTreeNode r s a)

(Eq r, Eq s, Eq a) => Eq (DirTreeNode r s a)

Defined in System.DirTree

Methods

(==) :: DirTreeNode r s a -> DirTreeNode r s a -> Bool

(/=) :: DirTreeNode r s a -> DirTreeNode r s a -> Bool

(Ord r, Ord s, Ord a) => Ord (DirTreeNode r s a)

Defined in System.DirTree

Methods

compare :: DirTreeNode r s a -> DirTreeNode r s a -> Ordering

(<) :: DirTreeNode r s a -> DirTreeNode r s a -> Bool

(<=) :: DirTreeNode r s a -> DirTreeNode r s a -> Bool

(>) :: DirTreeNode r s a -> DirTreeNode r s a -> Bool

(>=) :: DirTreeNode r s a -> DirTreeNode r s a -> Bool

max :: DirTreeNode r s a -> DirTreeNode r s a -> DirTreeNode r s a

min :: DirTreeNode r s a -> DirTreeNode r s a -> DirTreeNode r s a

(Show r, Show s, Show a) => Show (DirTreeNode r s a)

Defined in System.DirTree

Methods

showsPrec :: Int -> DirTreeNode r s a -> ShowS

show :: DirTreeNode r s a -> String

showList :: [DirTreeNode r s a] -> ShowS

Generic (DirTreeNode r s a)

Defined in System.DirTree

Associated Types

type Rep (DirTreeNode r s a) :: Type -> Type

Methods

from :: DirTreeNode r s a -> Rep (DirTreeNode r s a) x

to :: Rep (DirTreeNode r s a) x -> DirTreeNode r s a

(NFData r, NFData s, NFData a) => NFData (DirTreeNode r s a)

Defined in System.DirTree

Methods

rnf :: DirTreeNode r s a -> ()

type Rep (DirTreeNode r s a)

Defined in System.DirTree

type Rep (DirTreeNode r s a) = D1 (MetaData "DirTreeNode" "System.DirTree" "dirtree-0.0.1-LpN3AmmKCsNWVMG7Xg0uO" False) (C1 (MetaCons "Directory" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 r)) :+: (C1 (MetaCons "Symlink" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 s)) :+: C1 (MetaCons "File" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a))))

type FileType = DirTreeNode () () ()

A FileType is just a DirTreeNode with no contents.

fileTypeOfNode :: DirTreeNode a b c -> FileType

Gets the FileType of a DirTreeNode

Folds

mapDirTreeNode :: (r -> r') -> (s -> s') -> (a -> a') -> DirTreeNode r s a -> DirTreeNode r' s' a'

We can map over a DirTreeNode

foldDirTreeNode :: (r -> m) -> (s -> m) -> (a -> m) -> DirTreeNode r s a -> m

We can fold over a DirTreeNode by providing a function for each case.

traverseDirTreeNode :: Functor m => (r -> m r') -> (s -> m s') -> (a -> m a') -> DirTreeNode r s a -> m (DirTreeNode r' s' a')

We can fold over a DirTreeNode by providing a function for each case.

IO operations

getFileType :: FilePath -> IO FileType

Check a filepath for Type, throws an IOException if path does not exist.

readPath :: FilePath -> IO (DirTreeNode [String] FilePath ())

Reads the structure of the filepath

Helpers

type DirTreeN s a = DirTreeNode (FileMap (DirTree s a)) s a

A DirTreeN is a DirTreeNode with a the directory as a recursive DirTree.

FileMap

data FileMap a

A map from file names to

Instances

Functor FileMap

Defined in System.DirTree

Methods

fmap :: (a -> b) -> FileMap a -> FileMap b

(<$) :: a -> FileMap b -> FileMap a

Foldable FileMap

Defined in System.DirTree

Methods

fold :: Monoid m => FileMap m -> m

foldMap :: Monoid m => (a -> m) -> FileMap a -> m

foldr :: (a -> b -> b) -> b -> FileMap a -> b

foldr' :: (a -> b -> b) -> b -> FileMap a -> b

foldl :: (b -> a -> b) -> b -> FileMap a -> b

foldl' :: (b -> a -> b) -> b -> FileMap a -> b

foldr1 :: (a -> a -> a) -> FileMap a -> a

foldl1 :: (a -> a -> a) -> FileMap a -> a

toList :: FileMap a -> [a]

null :: FileMap a -> Bool

length :: FileMap a -> Int

elem :: Eq a => a -> FileMap a -> Bool

maximum :: Ord a => FileMap a -> a

minimum :: Ord a => FileMap a -> a

sum :: Num a => FileMap a -> a

product :: Num a => FileMap a -> a

Traversable FileMap

Defined in System.DirTree

Methods

traverse :: Applicative f => (a -> f b) -> FileMap a -> f (FileMap b)

sequenceA :: Applicative f => FileMap (f a) -> f (FileMap a)

mapM :: Monad m => (a -> m b) -> FileMap a -> m (FileMap b)

sequence :: Monad m => FileMap (m a) -> m (FileMap a)

FunctorWithIndex String FileMap

Defined in System.DirTree

Methods

imap :: (String -> a -> b) -> FileMap a -> FileMap b

imapped :: IndexedSetter String (FileMap a) (FileMap b) a b

FoldableWithIndex String FileMap

Defined in System.DirTree

Methods

ifoldMap :: Monoid m => (String -> a -> m) -> FileMap a -> m

ifolded :: IndexedFold String (FileMap a) a

ifoldr :: (String -> a -> b -> b) -> b -> FileMap a -> b

ifoldl :: (String -> b -> a -> b) -> b -> FileMap a -> b

ifoldr' :: (String -> a -> b -> b) -> b -> FileMap a -> b

ifoldl' :: (String -> b -> a -> b) -> b -> FileMap a -> b

TraversableWithIndex String FileMap

Defined in System.DirTree

Methods

itraverse :: Applicative f => (String -> a -> f b) -> FileMap a -> f (FileMap b)

itraversed :: IndexedTraversal String (FileMap a) (FileMap b) a b

Eq a => Eq (FileMap a)

Defined in System.DirTree

Methods

(==) :: FileMap a -> FileMap a -> Bool

(/=) :: FileMap a -> FileMap a -> Bool

Ord a => Ord (FileMap a)

Defined in System.DirTree

Methods

compare :: FileMap a -> FileMap a -> Ordering

(<) :: FileMap a -> FileMap a -> Bool

(<=) :: FileMap a -> FileMap a -> Bool

(>) :: FileMap a -> FileMap a -> Bool

(>=) :: FileMap a -> FileMap a -> Bool

max :: FileMap a -> FileMap a -> FileMap a

min :: FileMap a -> FileMap a -> FileMap a

(Show a, Show b) => Show (FileMap (DirTree a b))

Defined in System.DirTree

Methods

showsPrec :: Int -> FileMap (DirTree a b) -> ShowS

show :: FileMap (DirTree a b) -> String

showList :: [FileMap (DirTree a b)] -> ShowS

Generic (FileMap a)

Defined in System.DirTree

Associated Types

type Rep (FileMap a) :: Type -> Type

Methods

from :: FileMap a -> Rep (FileMap a) x

to :: Rep (FileMap a) x -> FileMap a

Semigroup a => Semigroup (FileMap a)

Defined in System.DirTree

Methods

(<>) :: FileMap a -> FileMap a -> FileMap a

sconcat :: NonEmpty (FileMap a) -> FileMap a

stimes :: Integral b => b -> FileMap a -> FileMap a

Semigroup a => Monoid (FileMap a)

Defined in System.DirTree

Methods

mempty :: FileMap a

mappend :: FileMap a -> FileMap a -> FileMap a

mconcat :: [FileMap a] -> FileMap a

NFData a => NFData (FileMap a)

Defined in System.DirTree

Methods

rnf :: FileMap a -> ()

type Rep (FileMap a)

Defined in System.DirTree

type Rep (FileMap a) = D1 (MetaData "FileMap" "System.DirTree" "dirtree-0.0.1-LpN3AmmKCsNWVMG7Xg0uO" True) (C1 (MetaCons "FileMap" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map String a))))

toFileList :: FileMap a -> [(String, a)]

Create a list of pairs of filenames and file values.

fromFileList :: [(String, a)] -> FileMap a

Create a FileMap from a list of pairs of filenames a file values.

(-.>) :: String -> a -> (String, DirTree x a)

(-|>) :: String -> a -> (String, DirTree a x)

(-/>) :: String -> [(String, DirTree a b)] -> (String, DirTree a b)

toDeepFileList :: FileMap (DirTree s a) -> [(FileKey, Either s a)]

Returns a list of FileMap

fromDeepFileList :: [(FileKey, Either s a)] -> FileMap (DirTree s a)

Returns an empty FileMap, if the input list is empty or contains files that does not correspond to a FileMap.

toFileNames :: FileMap a -> [String]

To a list of filenames

lookupFileMap :: String -> FileMap a -> Maybe a

Lookup a file using a filename

emptyFileMap :: FileMap a

empty filemap