System.FilePath.FilePather

Data type

data FilePather a

A function that takes a FilePath and produces a value.

Instances

Monad FilePather

Functor FilePather

Applicative FilePather

Monoid a => Monoid (FilePather a)

Constructor and unwrapper

(<?>) :: FilePather a -> FilePath -> a

filePather :: (FilePath -> a) -> FilePather a

Construct a FilePather from the given function

FilePather values

filePath :: FilePather FilePath

A value that runs the identity function.

always :: FilePather Bool

A value that always produces the value True.

always' :: FilePather (a -> Bool)

A value using a constant function that produces the value True.

never :: FilePather Bool

A value that always produces the value False.

never' :: FilePather (a -> Bool)

A value that always produces a constant function that produces the value False.

extension :: FilePather FilePath

A value that produces the extension of the given FilePath.

extension' :: FilePather (a -> FilePath)

A value using a constant function that produces the extension of the given FilePath.

directory :: FilePather FilePath

A value that produces the directory of the given FilePath.

directory' :: FilePather (a -> FilePath)

A value using a constant function that produces the directory of the given FilePath.

hasExtension :: FilePather Bool

A value that produces a value denoting whether or not the given FilePath has an extension.

hasExtension' :: FilePather (a -> Bool)

A value using a constant function that produces a value denoting whether or not the given FilePath has an extension.

splitExtension :: FilePather (String, String)

A value that produces a value splitting the given FilePath by its extension.

splitExtension' :: FilePather (a -> (String, String))

A value using a constant function that produces a value splitting the given FilePath by its extension.

splitDirectories :: FilePather [FilePath]

A value that produces a value splitting the given FilePath into its directories.

splitDirectories' :: FilePather (a -> [FilePath])

A value using a constant function that produces a value splitting the given FilePath into its directories.

hasTrailingPathSeparator :: FilePather Bool

A value that produces a value denoting whether or not the given FilePath has a trailing path separator.

hasTrailingPathSeparator' :: FilePather (a -> Bool)

A value using a constant function that produces a value denoting whether or not the given FilePath has a trailing path separator.

fileName :: FilePather FilePath

A value that produces the file name of the given FilePath.

fileName' :: FilePather (a -> FilePath)

A value using a constant function that produces the file name of the given FilePath.

baseName :: FilePather FilePath

A value that produces the base name of the given FilePath.

baseName' :: FilePather (a -> FilePath)

A value using a constant function that produces the base name of the given FilePath.

normalise :: FilePather FilePath

A value that normalises the given FilePath.

normalise' :: FilePather (a -> FilePath)

A value using a constant function that normalises the given FilePath.

makeValid :: FilePather FilePath

A value that makes valid the given FilePath.

makeValid' :: FilePather (a -> FilePath)

A value using a constant function that makes valid the given FilePath.

isRelative :: FilePather Bool

A value that produces a value denoting whether or not the given FilePath has is relative.

isRelative' :: FilePather (a -> Bool)

A value using a constant function that produces a value denoting whether or not the given FilePath has is relative.

isAbsolute :: FilePather Bool

A value that produces a value denoting whether or not the given FilePath has is absolute.

isAbsolute' :: FilePather (a -> Bool)

A value using a constant function that produces a value denoting whether or not the given FilePath has is absolute.

isValid :: FilePather Bool

A value that produces a value denoting whether or not the given FilePath has is valid.

isValid' :: FilePather (a -> Bool)

A value using a constant function that produces a value denoting whether or not the given FilePath has is valid.

Find predicates

data FileType

The possible types of a file.

Constructors

File

The type is a normal file.

Directory

The type is a directory.

Unknown

The type is unknown.

Instances

Eq FileType

Show FileType

type RecursePredicate = FilePather Bool

A recurse predicate takes a FilePath and returns whether or not to continue recursing on that file.

type FilterPredicate = FilePather (FileType -> Bool)

A filter predicate takes a FilePath and a file type and returns whether or not to filter the value.

isFile :: Applicative f => f (FileType -> Bool)

Compares for equivalence to a File in an applicative functor.

isDirectory :: Applicative f => f (FileType -> Bool)

Compares for equivalence to a Directory in an applicative functor.

isUnknown :: Applicative f => f (FileType -> Bool)

Compares for equivalence to Unknown in an applicative functor.

Find

find

Arguments

:: RecursePredicate

The recurse predicate determines whether to continue recursing on the given file path.

-> FilterPredicate

The filter predicate determines whether to keep the current file path.

-> FilePath

The file path to begin finding files.

-> IO [FilePath]

All files found.

Finds all files using the given recurse predicate and filter predicate in the given file path.

Combinators

extensionSatisfies :: (FilePath -> Bool) -> FilterPredicate

Returns a filter predicate based on whether a file extension satisfies a predicate.

extensionOneOf :: [FilePath] -> FilterPredicate

Returns a filter predicate based on whether a file extension is one of the given list of extensions.

extensionEq :: FilePath -> FilterPredicate

Returns a filter predicate based on whether a file extension equals the given extension.

findHere

Arguments

:: RecursePredicate

The recurse predicate determines whether to continue recursing on the given file path.

-> FilterPredicate

The filter predicate determines whether to keep the current file path.

-> IO [FilePath]

All files found.

Find in the current directory.