Documentation

Path of some base and type.

The type variables are:

• b — base, the base location of the path; absolute or relative.
• t — type, whether file or directory.

Internally is a string. The string can be of two formats only:

1. File format: file.txt, foo/bar.txt, /foo/bar.txt
2. Directory format: foo/, /foo/bar/

All directories end in a trailing separator. There are no duplicate path separators //, no .., no ./, no ~/, etc.

A relative path; one without a root. Note that a .. path component to represent the parent directory is not allowed by this library.

An absolute path.

A file path.

A directory path.

Path of some type. t represents the type, whether file or directory. Pattern match to find whether the path is absolute or relative.

Exceptions that can occur during path operations.

Since: path-0.6.0

Construct a Path Abs Dir using QuasiQuotes.

[absdir|/|]

[absdir|/home/chris|]

Remember: due to the nature of absolute paths a path like [absdir|/home/chris|] may compile on your platform, but it may not compile on another platform (Windows).

Since: path-0.5.13

Construct a Path Rel Dir using QuasiQuotes.

[absdir|/home|]</>[reldir|chris|]

Since: path-0.5.13

Construct a Path Abs File using QuasiQuotes.

[absfile|/home/chris/foo.txt|]

Remember: due to the nature of absolute paths a path like [absdir|/home/chris/foo.txt|] may compile on your platform, but it may not compile on another platform (Windows).

Since: path-0.5.13

Construct a Path Rel File using QuasiQuotes.

[absdir|/home/chris|]</>[relfile|foo.txt|]

Since: path-0.5.13

Append two paths.

The following cases are valid and the equalities hold:

$(mkAbsDir x) </> $(mkRelDir y) = $(mkAbsDir (x ++ "/" ++ y))

$(mkAbsDir x) </> $(mkRelFile y) = $(mkAbsFile (x ++ "/" ++ y))

$(mkRelDir x) </> $(mkRelDir y) = $(mkRelDir (x ++ "/" ++ y))

$(mkRelDir x) </> $(mkRelFile y) = $(mkRelFile (x ++ "/" ++ y))

The following are proven not possible to express:

$(mkAbsFile …) </> x

$(mkRelFile …) </> x

x </> $(mkAbsFile …)

x </> $(mkAbsDir …)

Polysemy version of stripProperPrefix.

Since: 0.1.0.0

Determines if the path in the first parameter is a proper prefix of the path in the second parameter.

The following properties hold:

not (x `isProperPrefixOf` x)

x `isProperPrefixOf` (x </> y)

Since: path-0.6.0

Take the parent path component from a path.

The following properties hold:

parent (x </> y) == x
parent "/x" == "/"
parent "x" == "."

On the root (absolute or relative), getting the parent is idempotent:

parent "/" = "/"
parent "." = "."

Extract the file part of a path.

The following properties hold:

filename (p </> a) == filename a

Extract the last directory name of a path.

The following properties hold:

dirname $(mkRelDir ".") == $(mkRelDir ".")

dirname (p </> a) == dirname a

Polysemy version of addExtension.

Since: 0.2.0.0

Polysemy version of splitExtension.

Since: 0.2.0.0

Polysemy version of fileExtension.

Since: 0.2.0.0

Polysemy version of replaceExtension.

Since: 0.2.0.0

Polysemy version of parseRelFile.

Since: 0.1.0.0

Polysemy version of parseAbsFile.

Since: 0.1.0.0

Polysemy version of parseRelDir.

Since: 0.1.0.0

Polysemy version of parseAbsDir.

Since: 0.1.0.0

Polysemy version of parseSomeDir.

Since: 0.2.0.0

Polysemy version of parseSomeFile.

Since: 0.2.0.0

Convert to a FilePath type.

All directories have a trailing slash, so if you want no trailing slash, you can use dropTrailingPathSeparator from the filepath package.

Convert absolute path to directory to FilePath type.

Convert relative path to directory to FilePath type.

Convert absolute path to file to FilePath type.

Convert relative path to file to FilePath type.

Convert a valid directory to a FilePath.

Convert a valid file to a FilePath.

Make a Path Abs Dir.

Remember: due to the nature of absolute paths this (e.g. /home/foo) may compile on your platform, but it may not compile on another platform (Windows).

Make a Path Rel Dir.

Make a Path Abs File.

Remember: due to the nature of absolute paths this (e.g. /home/foo) may compile on your platform, but it may not compile on another platform (Windows).

Make a Path Rel File.