filepath
Library for manipulating FilePaths in a cross platform way.
https://github.com/haskell/filepath#readme
| Version on this page: | 1.4.1.2 |
| LTS Haskell 22.34: | 1.4.300.1 |
| Stackage Nightly 2024-09-15: | 1.4.200.1 |
| Latest on Hackage: | 1.5.3.0 |
This version can be pinned in stack with:
filepath-1.4.1.2@sha256:bfe1beec4234b511f1b1c2c50dc390a80043dfca037613bad191681e1a9b1e88,2195Module documentation for 1.4.1.2
Depends on 1 package(full list with versions):
Used by 247 packages in lts-11.22(full list with versions):
accelerate, accelerate-llvm, accelerate-llvm-native, accelerate-llvm-ptx, Agda, airship, apply-refact, asciidiagram, atomic-write, audacity, autoexporter, b9, basic-prelude, bhoogle, brittany, buchhaltung, c2hs, Cabal, cabal2nix, cabal-doctest, cabal-install, cabal-rpm, cartel, cmdargs, conduit, conduit-extra, configuration-tools, criterion, crypto-api-tests, csv, cuda, datasets, debian-build, debug, dhall, dictionaries, directory, directory-tree, docker, doctest, and many more
FilePath 
The filepath package provides functionality for manipulating FilePath values, and is shipped with both GHC and the Haskell Platform. It provides three modules:
System.FilePath.Posixmanipulates POSIX/Linux styleFilePathvalues (with/as the path separator).System.FilePath.Windowsmanipulates Windows styleFilePathvalues (with either\or/as the path separator, and deals with drives).System.FilePathis an alias for the module appropriate to your platform.
All three modules provide the same API, and the same documentation (calling out differences in the different variants).
Should FilePath be an abstract data type?
The answer for this library is “no”. While an abstract FilePath has some advantages (mostly type safety), it also has some disadvantages:
- In Haskell the definition is
type FilePath = String, and all file-oriented functions operate on this type alias, e.g.readFile/writeFile. Any abstract type would require wrappers for these functions or lots of casts betweenStringand the abstraction. - It is not immediately obvious what a
FilePathis, and what is just a pureString. For example,/path/file.extis aFilePath. Is/?/path?path?file.ext?.ext?file? - Often it is useful to represent invalid files, e.g.
/foo/*.txtprobably isn’t an actual file, but a glob pattern. Other programs usefoo//barfor globs, which is definitely not a file, but might want to be stored as aFilePath. - Some programs use syntactic non-semantic details of the
FilePathto change their behaviour. For example,foo,foo/andfoo/.are all similar, and refer to the same location on disk, but may behave differently when passed to command-line tools. - A useful step to introducing an abstract
FilePathis to reduce the amount of manipulatingFilePathvalues like lists. This library hopes to help in that effort.