Safe Haskell	Safe
Language	Haskell2010

System.Directory.Contents.Types

Contents

Utilities

Description

Synopsis

data DirTree a
- = DirTree_Dir FilePath (Map FileName (DirTree a))
- | DirTree_File FilePath a
- | DirTree_Symlink FilePath (Symlink a)
data Symlink a
- = Symlink_Internal String FilePath
- | Symlink_External String (Map FileName (DirTree a))
filePath :: DirTree a -> FilePath
type FileName = String
fileName :: DirTree a -> FileName
fileNameMap :: [DirTree a] -> Map FileName (DirTree a)
insertSibling :: DirTree a -> Map FileName (DirTree a) -> Map FileName (DirTree a)
removeSibling :: DirTree a -> Map FileName (DirTree a) -> Map FileName (DirTree a)
withFirstChild :: Map FileName (DirTree a) -> (DirTree a -> Map FileName (DirTree a) -> x) -> Maybe x

Documentation

data DirTree a Source #

The contents of a directory, represented as a tree. See Symlink for special handling of symlinks.

Constructors

DirTree_Dir FilePath (Map FileName (DirTree a))
DirTree_File FilePath a
DirTree_Symlink FilePath (Symlink a)

Instances

Functor DirTree Source #
Instance details Defined in System.Directory.Contents.Types Methods fmap :: (a -> b) -> DirTree a -> DirTree b # (<$) :: a -> DirTree b -> DirTree a #
Foldable DirTree Source #
Instance details Defined in System.Directory.Contents.Types Methods fold :: Monoid m => DirTree m -> 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 #
Traversable DirTree Source #
Instance details Defined in System.Directory.Contents.Types 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) #
Eq a => Eq (DirTree a) Source #
Instance details Defined in System.Directory.Contents.Types Methods (==) :: DirTree a -> DirTree a -> Bool # (/=) :: DirTree a -> DirTree a -> Bool #
Data a => Data (DirTree a) Source #
Instance details Defined in System.Directory.Contents.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DirTree a -> c (DirTree a) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (DirTree a) # toConstr :: DirTree a -> Constr # dataTypeOf :: DirTree a -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (DirTree a)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (DirTree a)) # gmapT :: (forall b. Data b => b -> b) -> DirTree a -> DirTree a # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DirTree a -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DirTree a -> r # gmapQ :: (forall d. Data d => d -> u) -> DirTree a -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DirTree a -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DirTree a -> m (DirTree a) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DirTree a -> m (DirTree a) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DirTree a -> m (DirTree a) #
Ord a => Ord (DirTree a) Source #
Instance details Defined in System.Directory.Contents.Types 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 #
Read a => Read (DirTree a) Source #
Instance details Defined in System.Directory.Contents.Types Methods readsPrec :: Int -> ReadS (DirTree a) # readList :: ReadS [DirTree a] # readPrec :: ReadPrec (DirTree a) # readListPrec :: ReadPrec [DirTree a] #
Show a => Show (DirTree a) Source #
Instance details Defined in System.Directory.Contents.Types Methods showsPrec :: Int -> DirTree a -> ShowS # show :: DirTree a -> String # showList :: [DirTree a] -> ShowS #
Generic (DirTree a) Source #
Instance details Defined in System.Directory.Contents.Types Associated Types type Rep (DirTree a) :: Type -> Type # Methods from :: DirTree a -> Rep (DirTree a) x # to :: Rep (DirTree a) x -> DirTree a #
type Rep (DirTree a) Source #
Instance details Defined in System.Directory.Contents.Types type Rep (DirTree a) = D1 (MetaData "DirTree" "System.Directory.Contents.Types" "directory-contents-0.2.0.0-inplace" False) (C1 (MetaCons "DirTree_Dir" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map FileName (DirTree a)))) :+: (C1 (MetaCons "DirTree_File" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)) :+: C1 (MetaCons "DirTree_Symlink" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Symlink a)))))

data Symlink a Source #

Symlink cycles are prevented by separating symlinks into two categories: those that point to paths already within the directory hierarchy being recursively listed, and those that are not. In the former case, rather than following the symlink and listing the target redundantly, we simply store the symlink reference itself. In the latter case, we treat the symlink as we would any other folder and produce a list of its contents.

The String argument represents the symlink reference (e.g., "../somefile"). In the Symlink_Internal case, the second (FilePath) argument is the path to the symlink target. In the Symlink_External case, the second ([DirTree a]) argument contains the contents of the symlink target.

Constructors

Symlink_Internal String FilePath
Symlink_External String (Map FileName (DirTree a))

Instances

Functor Symlink Source #
Instance details Defined in System.Directory.Contents.Types Methods fmap :: (a -> b) -> Symlink a -> Symlink b # (<$) :: a -> Symlink b -> Symlink a #
Foldable Symlink Source #
Instance details Defined in System.Directory.Contents.Types Methods fold :: Monoid m => Symlink m -> m # foldMap :: Monoid m => (a -> m) -> Symlink a -> m # foldr :: (a -> b -> b) -> b -> Symlink a -> b # foldr' :: (a -> b -> b) -> b -> Symlink a -> b # foldl :: (b -> a -> b) -> b -> Symlink a -> b # foldl' :: (b -> a -> b) -> b -> Symlink a -> b # foldr1 :: (a -> a -> a) -> Symlink a -> a # foldl1 :: (a -> a -> a) -> Symlink a -> a # toList :: Symlink a -> [a] # null :: Symlink a -> Bool # length :: Symlink a -> Int # elem :: Eq a => a -> Symlink a -> Bool # maximum :: Ord a => Symlink a -> a # minimum :: Ord a => Symlink a -> a # sum :: Num a => Symlink a -> a # product :: Num a => Symlink a -> a #
Traversable Symlink Source #
Instance details Defined in System.Directory.Contents.Types Methods traverse :: Applicative f => (a -> f b) -> Symlink a -> f (Symlink b) # sequenceA :: Applicative f => Symlink (f a) -> f (Symlink a) # mapM :: Monad m => (a -> m b) -> Symlink a -> m (Symlink b) # sequence :: Monad m => Symlink (m a) -> m (Symlink a) #
Eq a => Eq (Symlink a) Source #
Instance details Defined in System.Directory.Contents.Types Methods (==) :: Symlink a -> Symlink a -> Bool # (/=) :: Symlink a -> Symlink a -> Bool #
Data a => Data (Symlink a) Source #
Instance details Defined in System.Directory.Contents.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Symlink a -> c (Symlink a) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Symlink a) # toConstr :: Symlink a -> Constr # dataTypeOf :: Symlink a -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Symlink a)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Symlink a)) # gmapT :: (forall b. Data b => b -> b) -> Symlink a -> Symlink a # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Symlink a -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Symlink a -> r # gmapQ :: (forall d. Data d => d -> u) -> Symlink a -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Symlink a -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Symlink a -> m (Symlink a) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Symlink a -> m (Symlink a) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Symlink a -> m (Symlink a) #
Ord a => Ord (Symlink a) Source #
Instance details Defined in System.Directory.Contents.Types Methods compare :: Symlink a -> Symlink a -> Ordering # (<) :: Symlink a -> Symlink a -> Bool # (<=) :: Symlink a -> Symlink a -> Bool # (>) :: Symlink a -> Symlink a -> Bool # (>=) :: Symlink a -> Symlink a -> Bool # max :: Symlink a -> Symlink a -> Symlink a # min :: Symlink a -> Symlink a -> Symlink a #
Read a => Read (Symlink a) Source #
Instance details Defined in System.Directory.Contents.Types Methods readsPrec :: Int -> ReadS (Symlink a) # readList :: ReadS [Symlink a] # readPrec :: ReadPrec (Symlink a) # readListPrec :: ReadPrec [Symlink a] #
Show a => Show (Symlink a) Source #
Instance details Defined in System.Directory.Contents.Types Methods showsPrec :: Int -> Symlink a -> ShowS # show :: Symlink a -> String # showList :: [Symlink a] -> ShowS #
Generic (Symlink a) Source #
Instance details Defined in System.Directory.Contents.Types Associated Types type Rep (Symlink a) :: Type -> Type # Methods from :: Symlink a -> Rep (Symlink a) x # to :: Rep (Symlink a) x -> Symlink a #
type Rep (Symlink a) Source #
Instance details Defined in System.Directory.Contents.Types type Rep (Symlink a) = D1 (MetaData "Symlink" "System.Directory.Contents.Types" "directory-contents-0.2.0.0-inplace" False) (C1 (MetaCons "Symlink_Internal" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) :+: C1 (MetaCons "Symlink_External" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map FileName (DirTree a)))))

Utilities

filePath :: DirTree a -> FilePath Source #

Extract the FilePath from a DirTree node

type FileName = String Source #

File names, as opposed to file paths, are used to uniquely identify siblings at each level

fileName :: DirTree a -> FileName Source #

Generate the key used to identify siblings

fileNameMap :: [DirTree a] -> Map FileName (DirTree a) Source #

Construct a map of files indexed by filename. Should only be used for a particular generation or level in the directory hierarchy (since that's the only time we can be sure that names are unique)

insertSibling :: DirTree a -> Map FileName (DirTree a) -> Map FileName (DirTree a) Source #

Add a sibling to a map of files

removeSibling :: DirTree a -> Map FileName (DirTree a) -> Map FileName (DirTree a) Source #

Remove sibling from a map of files

withFirstChild :: Map FileName (DirTree a) -> (DirTree a -> Map FileName (DirTree a) -> x) -> Maybe x Source #

Map a function over the first child and the rest of the children