Data.DirForest

A directory forest of files associated with values

This module is meant to be imported like this:

import Data.DirForest (DirForest)
import qualified Data.DirForest as DF

Dirforest types

data DirTree a

Constructors

NodeFile a

NodeDir (DirForest a)

Instances

Foldable DirTree

Defined in Data.DirForest

Methods

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

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

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

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

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

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

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

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

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

toList :: DirTree a -> [a]

null :: DirTree a -> Bool

length :: DirTree a -> Int

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

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

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

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

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

Eq1 DirTree

Defined in Data.DirForest

Methods

liftEq :: (a -> b -> Bool) -> DirTree a -> DirTree b -> Bool

Ord1 DirTree

Defined in Data.DirForest

Methods

liftCompare :: (a -> b -> Ordering) -> DirTree a -> DirTree b -> Ordering

Traversable DirTree

Defined in Data.DirForest

Methods

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

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

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

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

Functor DirTree

Defined in Data.DirForest

Methods

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

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

HasCodec a => FromJSON (DirTree a)

Defined in Data.DirForest

Methods

parseJSON :: Value -> Parser (DirTree a)

parseJSONList :: Value -> Parser [DirTree a]

HasCodec a => ToJSON (DirTree a)

Defined in Data.DirForest

Methods

toJSON :: DirTree a -> Value

toEncoding :: DirTree a -> Encoding

toJSONList :: [DirTree a] -> Value

toEncodingList :: [DirTree a] -> Encoding

HasCodec a => HasCodec (DirTree a)

Defined in Data.DirForest

Methods

codec :: JSONCodec (DirTree a)

listCodecForStringCompatibility :: JSONCodec [DirTree a]

Generic (DirTree a)

Defined in Data.DirForest

Associated Types

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

Methods

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

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

Show a => Show (DirTree a)

Defined in Data.DirForest

Methods

showsPrec :: Int -> DirTree a -> ShowS

show :: DirTree a -> String

showList :: [DirTree a] -> ShowS

NFData a => NFData (DirTree a)

Defined in Data.DirForest

Methods

rnf :: DirTree a -> ()

Eq a => Eq (DirTree a)

Defined in Data.DirForest

Methods

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

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

Ord a => Ord (DirTree a)

Defined in Data.DirForest

Methods

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

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

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

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

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

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

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

Validity a => Validity (DirTree a)

Defined in Data.DirForest

Methods

validate :: DirTree a -> Validation

type Rep (DirTree a)

Defined in Data.DirForest

type Rep (DirTree a) = D1 ('MetaData "DirTree" "Data.DirForest" "dirforest-0.1.0.0-Kx7FjqyA5HqHM6ZA0ofIz0" 'False) (C1 ('MetaCons "NodeFile" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)) :+: C1 ('MetaCons "NodeDir" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (DirForest a))))

newtype DirForest a

Constructors

DirForest

Fields

• unDirForest :: Map FilePath (DirTree a)

Instances

Foldable DirForest

Defined in Data.DirForest

Methods

fold :: Monoid m => DirForest m -> m

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

foldMap' :: Monoid m => (a -> m) -> DirForest a -> m

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

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

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

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

foldr1 :: (a -> a -> a) -> DirForest a -> a

foldl1 :: (a -> a -> a) -> DirForest a -> a

toList :: DirForest a -> [a]

null :: DirForest a -> Bool

length :: DirForest a -> Int

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

maximum :: Ord a => DirForest a -> a

minimum :: Ord a => DirForest a -> a

sum :: Num a => DirForest a -> a

product :: Num a => DirForest a -> a

Eq1 DirForest

Defined in Data.DirForest

Methods

liftEq :: (a -> b -> Bool) -> DirForest a -> DirForest b -> Bool

Ord1 DirForest

Defined in Data.DirForest

Methods

liftCompare :: (a -> b -> Ordering) -> DirForest a -> DirForest b -> Ordering

Traversable DirForest

Defined in Data.DirForest

Methods

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

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

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

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

Functor DirForest

Defined in Data.DirForest

Methods

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

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

HasCodec a => FromJSON (DirForest a)

Defined in Data.DirForest

Methods

parseJSON :: Value -> Parser (DirForest a)

parseJSONList :: Value -> Parser [DirForest a]

HasCodec a => ToJSON (DirForest a)

Defined in Data.DirForest

Methods

toJSON :: DirForest a -> Value

toEncoding :: DirForest a -> Encoding

toJSONList :: [DirForest a] -> Value

toEncodingList :: [DirForest a] -> Encoding

HasCodec a => HasCodec (DirForest a)

Defined in Data.DirForest

Methods

codec :: JSONCodec (DirForest a)

listCodecForStringCompatibility :: JSONCodec [DirForest a]

Generic (DirForest a)

Defined in Data.DirForest

Associated Types

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

Methods

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

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

Show a => Show (DirForest a)

Defined in Data.DirForest

Methods

showsPrec :: Int -> DirForest a -> ShowS

show :: DirForest a -> String

showList :: [DirForest a] -> ShowS

NFData a => NFData (DirForest a)

Defined in Data.DirForest

Methods

rnf :: DirForest a -> ()

Eq a => Eq (DirForest a)

Defined in Data.DirForest

Methods

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

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

Ord a => Ord (DirForest a)

Defined in Data.DirForest

Methods

compare :: DirForest a -> DirForest a -> Ordering

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

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

(>) :: DirForest a -> DirForest a -> Bool

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

max :: DirForest a -> DirForest a -> DirForest a

min :: DirForest a -> DirForest a -> DirForest a

Validity a => Validity (DirForest a)

Defined in Data.DirForest

Methods

validate :: DirForest a -> Validation

type Rep (DirForest a)

Defined in Data.DirForest

type Rep (DirForest a) = D1 ('MetaData "DirForest" "Data.DirForest" "dirforest-0.1.0.0-Kx7FjqyA5HqHM6ZA0ofIz0" 'True) (C1 ('MetaCons "DirForest" 'PrefixI 'True) (S1 ('MetaSel ('Just "unDirForest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map FilePath (DirTree a)))))

data InsertionError a

Constructors

FileInTheWay (Path Rel File) a

DirInTheWay (Path Rel Dir) (DirForest a)

Instances

Generic (InsertionError a)

Defined in Data.DirForest

Associated Types

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

Methods

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

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

Show a => Show (InsertionError a)

Defined in Data.DirForest

Methods

showsPrec :: Int -> InsertionError a -> ShowS

show :: InsertionError a -> String

showList :: [InsertionError a] -> ShowS

Eq a => Eq (InsertionError a)

Defined in Data.DirForest

Methods

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

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

Ord a => Ord (InsertionError a)

Defined in Data.DirForest

Methods

compare :: InsertionError a -> InsertionError a -> Ordering

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

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

(>) :: InsertionError a -> InsertionError a -> Bool

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

max :: InsertionError a -> InsertionError a -> InsertionError a

min :: InsertionError a -> InsertionError a -> InsertionError a

Validity a => Validity (InsertionError a)

Defined in Data.DirForest

Methods

validate :: InsertionError a -> Validation

type Rep (InsertionError a)

Defined in Data.DirForest

type Rep (InsertionError a) = D1 ('MetaData "InsertionError" "Data.DirForest" "dirforest-0.1.0.0-Kx7FjqyA5HqHM6ZA0ofIz0" 'False) (C1 ('MetaCons "FileInTheWay" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Path Rel File)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)) :+: C1 ('MetaCons "DirInTheWay" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Path Rel Dir)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (DirForest a))))

data FOD a

File or Dir

Constructors

F a

D

Instances

Functor FOD

Defined in Data.DirForest

Methods

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

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

Generic (FOD a)

Defined in Data.DirForest

Associated Types

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

Methods

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

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

Show a => Show (FOD a)

Defined in Data.DirForest

Methods

showsPrec :: Int -> FOD a -> ShowS

show :: FOD a -> String

showList :: [FOD a] -> ShowS

Eq a => Eq (FOD a)

Defined in Data.DirForest

Methods

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

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

Ord a => Ord (FOD a)

Defined in Data.DirForest

Methods

compare :: FOD a -> FOD a -> Ordering

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

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

(>) :: FOD a -> FOD a -> Bool

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

max :: FOD a -> FOD a -> FOD a

min :: FOD a -> FOD a -> FOD a

Validity a => Validity (FOD a)

Defined in Data.DirForest

Methods

validate :: FOD a -> Validation

type Rep (FOD a)

Defined in Data.DirForest

type Rep (FOD a) = D1 ('MetaData "FOD" "Data.DirForest" "dirforest-0.1.0.0-Kx7FjqyA5HqHM6ZA0ofIz0" 'False) (C1 ('MetaCons "F" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)) :+: C1 ('MetaCons "D" 'PrefixI 'False) (U1 :: Type -> Type))

Comparisons

eq1DirTree :: (a -> b -> Bool) -> DirTree a -> DirTree b -> Bool

ord1DirTree :: (a -> b -> Ordering) -> DirTree a -> DirTree b -> Ordering

eq1DirForest :: (a -> b -> Bool) -> DirForest a -> DirForest b -> Bool

ord1DirForest :: (a -> b -> Ordering) -> DirForest a -> DirForest b -> Ordering

Query

null :: DirForest a -> Bool

True iff the forest is entirely empty

nullFiles :: DirForest a -> Bool

True iff there are only empty directories in the directory forest

lookup :: forall a. Path Rel File -> DirForest a -> Maybe a

Construction

empty :: DirForest a

The empty forest

singletonFile :: Path Rel File -> a -> DirForest a

singletonDir :: Path Rel Dir -> DirForest a

insertFile :: forall a. Path Rel File -> a -> DirForest a -> Either (InsertionError a) (DirForest a)

insertDir :: forall a. Path Rel Dir -> DirForest a -> Either (InsertionError a) (DirForest a)

Traversal

mapWithPath :: (Path Rel File -> a -> b) -> DirForest a -> DirForest b

traverseWithPath :: forall a b f. Applicative f => (Path Rel File -> a -> f b) -> DirForest a -> f (DirForest b)

traverseWithPath_ :: forall a b f. Applicative f => (Path Rel File -> a -> f b) -> DirForest a -> f ()

Pruning

pruneEmptyDirs :: DirForest a -> Maybe (DirForest a)

Remove all empty directories from a DirForest

This will return Nothing if the root was also empty.

anyEmptyDir :: DirForest a -> Bool

Conversion

Map

fromFileMap :: Map (Path Rel File) a -> Either (InsertionError a) (DirForest a)

toFileMap :: DirForest a -> Map (Path Rel File) a

fromMap :: Map FilePath (FOD a) -> Either (InsertionError a) (DirForest a)

toMap :: DirForest a -> Map FilePath (FOD a)

List

fromFileList :: [(Path Rel File, a)] -> Either (InsertionError a) (DirForest a)

toFileList :: DirForest a -> [(Path Rel File, a)]

IO

Read

read :: forall a b m. MonadIO m => Path b Dir -> (Path b File -> m a) -> m (DirForest a)

readNonHidden :: forall a b m. MonadIO m => Path b Dir -> (Path b File -> m a) -> m (DirForest a)

readFiltered :: forall a b m. MonadIO m => (Path b File -> Bool) -> (Path b Dir -> Bool) -> Path b Dir -> (Path b File -> m a) -> m (DirForest a)

readNonHiddenFiltered :: forall a b m. MonadIO m => (Path b File -> Bool) -> (Path b Dir -> Bool) -> Path b Dir -> (Path b File -> m a) -> m (DirForest a)

readOneLevel :: forall a b m. MonadIO m => Path b Dir -> (Path b File -> m a) -> m (DirForest a)

readOneLevelNonHidden :: forall a b m. MonadIO m => Path b Dir -> (Path b File -> m a) -> m (DirForest a)

readOneLevelFiltered :: forall a b m. MonadIO m => (Path b File -> Bool) -> (Path b Dir -> Bool) -> Path b Dir -> (Path b File -> m a) -> m (DirForest a)

readOneLevelNonHiddenFiltered :: forall a b m. MonadIO m => (Path b File -> Bool) -> (Path b Dir -> Bool) -> Path b Dir -> (Path b File -> m a) -> m (DirForest a)

hiddenRel :: Path Rel t -> Bool

Write

write :: forall a b. (Show a, Ord a) => Path b Dir -> DirForest a -> (Path b File -> a -> IO ()) -> IO ()

Combinations

Union

data InsertValidation e a

Constructors

InsertionErrors (NonEmpty (InsertionError e))

NoInsertionErrors a

Instances

Applicative (InsertValidation e)

Defined in Data.DirForest

Methods

pure :: a -> InsertValidation e a

(<*>) :: InsertValidation e (a -> b) -> InsertValidation e a -> InsertValidation e b

liftA2 :: (a -> b -> c) -> InsertValidation e a -> InsertValidation e b -> InsertValidation e c

(*>) :: InsertValidation e a -> InsertValidation e b -> InsertValidation e b

(<*) :: InsertValidation e a -> InsertValidation e b -> InsertValidation e a

Functor (InsertValidation e)

Defined in Data.DirForest

Methods

fmap :: (a -> b) -> InsertValidation e a -> InsertValidation e b

(<$) :: a -> InsertValidation e b -> InsertValidation e a

Generic (InsertValidation e a)

Defined in Data.DirForest

Associated Types

type Rep (InsertValidation e a) :: Type -> Type

Methods

from :: InsertValidation e a -> Rep (InsertValidation e a) x

to :: Rep (InsertValidation e a) x -> InsertValidation e a

(Show e, Show a) => Show (InsertValidation e a)

Defined in Data.DirForest

Methods

showsPrec :: Int -> InsertValidation e a -> ShowS

show :: InsertValidation e a -> String

showList :: [InsertValidation e a] -> ShowS

(Eq e, Eq a) => Eq (InsertValidation e a)

Defined in Data.DirForest

Methods

(==) :: InsertValidation e a -> InsertValidation e a -> Bool

(/=) :: InsertValidation e a -> InsertValidation e a -> Bool

(Validity e, Validity a) => Validity (InsertValidation e a)

Defined in Data.DirForest

Methods

validate :: InsertValidation e a -> Validation

type Rep (InsertValidation e a)

Defined in Data.DirForest

type Rep (InsertValidation e a) = D1 ('MetaData "InsertValidation" "Data.DirForest" "dirforest-0.1.0.0-Kx7FjqyA5HqHM6ZA0ofIz0" 'False) (C1 ('MetaCons "InsertionErrors" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NonEmpty (InsertionError e)))) :+: C1 ('MetaCons "NoInsertionErrors" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

unpackInsertValidation :: InsertValidation e a -> Either (NonEmpty (InsertionError e)) a

union :: DirForest a -> DirForest a -> InsertValidation a (DirForest a)

unionWith :: (a -> a -> a) -> DirForest a -> DirForest a -> InsertValidation a (DirForest a)

unionWithKey :: forall a. (Path Rel File -> a -> a -> a) -> DirForest a -> DirForest a -> InsertValidation a (DirForest a)

unions :: [DirForest a] -> Either (InsertionError a) (DirForest a)

Intersection

intersection :: DirForest a -> DirForest b -> DirForest a

intersectionWith :: (a -> b -> c) -> DirForest a -> DirForest b -> DirForest c

intersectionWithKey :: forall a b c. (Path Rel File -> a -> b -> c) -> DirForest a -> DirForest b -> DirForest c

intersections :: [DirForest a] -> DirForest a

Difference

difference :: DirForest a -> DirForest b -> DirForest a

differenceWith :: (a -> b -> Maybe a) -> DirForest a -> DirForest b -> DirForest a

differenceWithKey :: forall a b. (Path Rel File -> a -> b -> Maybe a) -> DirForest a -> DirForest b -> DirForest a

Filter

filter :: (a -> Bool) -> DirForest a -> DirForest a

filterWithKey :: forall a. (Path Rel File -> a -> Bool) -> DirForest a -> DirForest a

filterHidden :: forall a. DirForest a -> DirForest a