Portability | portable |
---|---|
Maintainer | jmillikin@gmail.com |
Safe Haskell | Safe-Infered |
Filesystem.Path.CurrentOS
Description
Re‐exports contents of Filesystem.Path.Rules, defaulting to the current OS’s rules when needed.
- module Filesystem.Path
- currentOS :: Rules ByteString
- toText :: FilePath -> Either Text Text
- fromText :: Text -> FilePath
- encode :: FilePath -> ByteString
- decode :: ByteString -> FilePath
- encodeString :: FilePath -> String
- decodeString :: String -> FilePath
- valid :: FilePath -> Bool
- splitSearchPath :: ByteString -> [FilePath]
Documentation
module Filesystem.Path
Type conversions
toText :: FilePath -> Either Text Text
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
encode :: FilePath -> ByteString
Convert a FilePath
to a platform‐specific format, suitable
for use with external OS functions.
Since: 0.3
decode :: ByteString -> FilePath
Convert a FilePath
from a platform‐specific format, suitable
for use with external OS functions.
Since: 0.3
encodeString :: FilePath -> String
decodeString :: String -> FilePath
Rule‐specific path properties
splitSearchPath :: ByteString -> [FilePath]
Split a search path, such as $PATH
or $PYTHONPATH
, into a list
of FilePath
s.