Talash.Files

A potentially too simple interface for getting candidates for search from file trees. Doesn't follow symbolic links. For a better solution to this use unix-recursive.

Types

data Conf

Constructors

Conf

Fields

• includeFile :: FileStatus -> ByteString -> IO Bool

  Test for whether to include a file in the file tree. The second argument is the base name of the file.

• filterPath :: ByteString -> Bool

  Test used to determine whether to enter a directory to search for files.

data FindConf

A simple type to represent a search either for a specific set of extensions or esle for excluding a specific set of extensions. An extension here is just the part of the filename after the last . i.e this module doesn't handle multiple extensions.

Constructors

Find !(HashSet ByteString)

Ignore !(HashSet ByteString)

Instances

Show FindConf

Defined in Talash.Files

Methods

showsPrec :: Int -> FindConf -> ShowS

show :: FindConf -> String

showList :: [FindConf] -> ShowS

data FindInDirs

Constructors

FindInDirs

Fields

• confLocal :: FindConf

  The configuration of finding or excluding the extensions for this set of directories.

• dirsLocal :: [ByteString]

  The list of directories to which this configuration should apply.

data FileTree a

Constructors

Dir

The vector of trees formed by subdirectories

Fields

• rootDir :: a

  The root directory

• dirFiles :: Vector a

  The files in the root directory that are not subdirectories

• subDirs :: Vector (FileTree a)

Instances

Eq a => Eq (FileTree a)

Defined in Talash.Files

Methods

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

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

Show a => Show (FileTree a)

Defined in Talash.Files

Methods

showsPrec :: Int -> FileTree a -> ShowS

show :: FileTree a -> String

showList :: [FileTree a] -> ShowS

File Collection

defConf :: Conf

Default configuration, include every file and search directory.

withExts

Arguments

:: [ByteString]

The set of extensions to search for

-> FindConf

ignoreExts

Arguments

:: [ByteString]

The set of extensions to ignore.

-> FindConf

findWithExts :: FindInDirs -> IO (Vector (FileTree Text))

Find files in the given set of directories that either have a specific extension (Find case) or else excluding a certain set of extensiosn (Ignore case).

findFilesInDirs :: [FindInDirs] -> IO (Vector (FileTree Text))

Like findWithExts but applied to mutliple lists of directories each with their own configuration of extensions.

executables :: IO (Vector Text)

Find all the executables in PATH

Internal Details

dirContentsWith :: Conf -> ByteString -> IO (Vector (Either ByteString ByteString))

Given the configuration and a directory returns a vector where the Left elements are the files in the directory that pass the includeFile test while the Right elements are subdirectories that pass the filterPath test.

fileTreeWith :: Conf -> ByteString -> IO (FileTree Text)

Constructs the file tree with the given the second argument at the root according to the given configuration.

minify :: FileTree Text -> FileTree Text

Collapses the directories with only subdirectory and no other files.

flatten :: FileTree Text -> Vector Text

Flattens the fileTree by completing the paths of the file relative to that of root directory.

ext :: ByteString -> ByteString

The last extension of a file. Returns empty bytestring if there is none.