Filesystem.Path.Rules

The type of platformFormat for Rules is conditionally selected at compilation time. As such it is only intended for direct use with external OS functions and code that expects platformFormat to be stable across platforms may fail to subsequently compile on a differing platform.

For example: on Windows or OSX platformFormat will be Text, and on Linux it will be ByteString.

If portability is a concern, restrict usage to functions which do not expose platformFormat directly.

Linux, BSD, and other UNIX or UNIX-like operating systems.

Linux, BSD, and other UNIX or UNIX-like operating systems.

This is a variant of posix for use with GHC 7.2, which tries to decode file paths in its IO computations.

Since: 0.3.3 / 0.4.2

Linux, BSD, and other UNIX or UNIX-like operating systems.

This is a variant of posix for use with GHC 7.4 or later, which tries to decode file paths in its IO computations.

Since: 0.3.7 / 0.4.6

Windows and DOS

Darwin and Mac OS X.

This is almost identical to posix, but with a native path type of Text rather than ByteString.

Since: 0.3.4 / 0.4.3

Darwin and Mac OS X.

This is a variant of darwin for use with GHC 7.2 or later, which tries to decode file paths in its IO computations.

Since: 0.3.4 / 0.4.3

Attempt to convert a FilePath to human‐readable text.

If the path is decoded successfully, the result is a Right containing the decoded text. Successfully decoded text can be converted back to the original path using fromText.

If the path cannot be decoded, the result is a Left containing an approximation of the original path. If displayed to the user, this value should be accompanied by some warning that the path has an invalid encoding. Approximated text cannot be converted back to the original path.

This function ignores the user’s locale, and assumes all file paths are encoded in UTF8. If you need to display file paths with an unusual or obscure encoding, use encode and then decode them manually.

Since: 0.2

Convert human‐readable text into a FilePath.

This function ignores the user’s locale, and assumes all file paths are encoded in UTF8. If you need to create file paths with an unusual or obscure encoding, encode them manually and then use decode.

Since: 0.2

Convert a FilePath to a platform‐specific format, suitable for use with external OS functions.

Note: The type of platformTextFormat can change depending upon the underlying compilation platform. Consider using toText or encodeString instead. See Rules for more information.

Since: 0.3

Convert a FilePath from a platform‐specific format, suitable for use with external OS functions.

Note: The type of platformTextFormat can change depending upon the underlying compilation platform. Consider using fromText or decodeString instead. See Rules for more information.

Since: 0.3

Attempt to convert a FilePath to a string suitable for use with functions in System.IO. The contents of this string are platform‐dependent, and are not guaranteed to be human‐readable. For converting FilePaths to a human‐readable format, use toText.

Since: 0.3.1

Attempt to parse a FilePath from a string suitable for use with functions in System.IO. Do not use this function for parsing human‐readable paths, as the character set decoding is platform‐dependent. For converting human‐readable text to a FilePath, use fromText.

Since: 0.3.1

Check if a FilePath is valid; it must not contain any illegal characters, and must have a root appropriate to the current Rules.

Split a search path, such as $PATH or $PYTHONPATH, into a list of FilePaths.

Note: The type of platformTextFormat can change depending upon the underlying compilation platform. Consider using splitSearchPathString instead. See Rules for more information.

splitSearchPathString is like splitSearchPath, but takes a string encoded in the format used by System.IO.