System.Directory.PathWalk

Provides path traversal functions much like Python's os.walk.

Documentation

type Callback a = FilePath -> [FilePath] -> [FilePath] -> IO a

Called with a directory, list of relative subdirectories, and a list of file names. If using pathWalk, the callback always returns '()'. If using pathWalkInterruptible, it returns whether to continue, prevent recursing further, or stop traversal entirely.

pathWalk :: FilePath -> Callback () -> IO ()

pathWalk recursively enumerates the given root directory, calling callback once per directory with the traversed directory name, a list of subdirectories, and a list of files.

The subdirectories and file names are always relative to the root given.

pathWalk "src" $ \dir subdirs files -> do
  forM_ files $ \file -> do
    when ("Test.hs" `isSuffixOf` file) $ do
      registerTestFile $ dir </> file

data WalkStatus

The callback given to pathWalkInterruptible returns a WalkStatus which determines which subsequent directories are traversed.

Constructors

Continue

Continue recursing all subdirectories.

StopRecursing

Do not traverse deeper.

Stop

Stop recursing entirely.

Instances

Eq WalkStatus

Show WalkStatus

pathWalkInterruptible :: FilePath -> Callback WalkStatus -> IO ()

Traverses a directory tree, just like pathWalk, except that the callback can determine whether to continue traversal. See WalkStatus.