foundation-0.0.23: Alternative prelude with batteries and no dependencies

License | BSD-style
Maintainer | foundation
Stability | experimental
Portability | portable
Safe Haskell | None
Language | Haskell2010

Foundation.VFS.FilePath

Contents

- conversion
  - unsafe

Description

# Opaque implementation for FilePath

The underlying type of a FilePath is a `ByteArray`. It is indeed like this because for some systems (Unix systems) a `FilePath` is a null terminated array of bytes.

# FilePath and FileName for type checking validation

In order to add some constraint at compile time, it is not possible to append (`</>`) a `FilePath` to another `FilePath`. You can only append (`</>`) a `FileName` to a given `FilePath`.

Synopsis

- data FilePath
- data Relativity
  - = Absolute
  - | Relative
- data FileName
- filePathToString :: FilePath -> String
- filePathToLString :: FilePath -> [Char]
- unsafeFilePath :: Relativity -> [FileName] -> FilePath
- unsafeFileName :: UArray Word8 -> FileName
- extension :: FileName -> Maybe FileName

# Documentation

data FilePath Source #

FilePath is a collection of FileName

TODO: Eq and Ord are implemented using Show This is not very efficient and would need to be improved Also, it is possible the ordering is not necessary what we want in this case.

A FilePath is one of the following:

- An Absolute:
- starts with one of the follwing "/"
- A relative:
- don't start with a "/"
- authorised:
- "/"
- "filepath"
- "."
- ".."
- "workhaskellhs-foundation"
- unauthorised
- "path//"

Instances

Eq FilePath Source # |
Instance details Defined in Foundation.VFS.FilePath Methods (==) :: FilePath -> FilePath -> Bool Source # (/=) :: FilePath -> FilePath -> Bool Source #
Ord FilePath Source # |
Instance details Defined in Foundation.VFS.FilePath Methods compare :: FilePath -> FilePath -> Ordering Source # (<) :: FilePath -> FilePath -> Bool Source # (<=) :: FilePath -> FilePath -> Bool Source # (>) :: FilePath -> FilePath -> Bool Source # (>=) :: FilePath -> FilePath -> Bool Source # max :: FilePath -> FilePath -> FilePath Source # min :: FilePath -> FilePath -> FilePath Source #
Show FilePath Source # |
Instance details Defined in Foundation.VFS.FilePath Methods showsPrec :: Int -> FilePath -> ShowS Source # show :: FilePath -> String Source # showList :: [FilePath] -> ShowS Source #
IsString FilePath Source # |
Instance details Defined in Foundation.VFS.FilePath Methods fromString :: String -> FilePath Source #
Path FilePath Source # |

Instance details

Defined in Foundation.VFS.FilePath

Associated Types

type PathEnt FilePath :: Type Source #

type PathPrefix FilePath :: Type Source #

type PathSuffix FilePath :: Type Source #

Methods

(</>) :: FilePath -> PathEnt FilePath -> FilePath Source #

splitPath :: FilePath -> (PathPrefix FilePath, [PathEnt FilePath], PathSuffix FilePath) Source #

buildPath :: (PathPrefix FilePath, [PathEnt FilePath], PathSuffix FilePath) -> FilePath Source #

type PathEnt FilePath Source # |
Instance details Defined in Foundation.VFS.FilePath type PathEnt FilePath = FileName
type PathPrefix FilePath Source # |
Instance details Defined in Foundation.VFS.FilePath type PathPrefix FilePath = Relativity
type PathSuffix FilePath Source # |
Instance details Defined in Foundation.VFS.FilePath type PathSuffix FilePath = ()

data Relativity Source #

information about type of FilePath

A file path being only `Relative` or `Absolute`.

Constructors

Absolute |
Relative |

Instances

Eq Relativity Source # |
Instance details Defined in Foundation.VFS.FilePath Methods (==) :: Relativity -> Relativity -> Bool Source # (/=) :: Relativity -> Relativity -> Bool Source #
Show Relativity Source # |
Instance details Defined in Foundation.VFS.FilePath Methods showsPrec :: Int -> Relativity -> ShowS Source # show :: Relativity -> String Source # showList :: [Relativity] -> ShowS Source #

data FileName Source #

A filename (or path entity) in the FilePath

- Authorised
- ""
- "."
- ".."
- "foundation"
- Unauthorised
- "/"
- "file/"
- "/file"
- "file/path"

Instances

Eq FileName Source # |
Instance details Defined in Foundation.VFS.FilePath Methods (==) :: FileName -> FileName -> Bool Source # (/=) :: FileName -> FileName -> Bool Source #
Show FileName Source # |
Instance details Defined in Foundation.VFS.FilePath Methods showsPrec :: Int -> FileName -> ShowS Source # show :: FileName -> String Source # showList :: [FileName] -> ShowS Source #
IsString FileName Source # |
Instance details Defined in Foundation.VFS.FilePath Methods fromString :: String -> FileName Source #
Semigroup FileName Source # |
Instance details Defined in Foundation.VFS.FilePath Methods (<>) :: FileName -> FileName -> FileName Source # sconcat :: NonEmpty FileName -> FileName Source # stimes :: Integral b => b -> FileName -> FileName Source #
Monoid FileName Source # |
Instance details Defined in Foundation.VFS.FilePath Methods mempty :: FileName Source # mappend :: FileName -> FileName -> FileName Source # mconcat :: [FileName] -> FileName Source #

# conversion

filePathToString :: FilePath -> String Source #

filePathToLString :: FilePath -> [Char] Source #

conversion of a FilePath into a list of Char

this function may throw exceptions

## unsafe

unsafeFilePath :: Relativity -> [FileName] -> FilePath Source #

build a file path from a given list of filename

this is unsafe and is mainly needed for testing purpose

unsafeFileName :: UArray Word8 -> FileName Source #

build a file name from a given ByteArray

this is unsafe and is mainly needed for testing purpose

extension :: FileName -> Maybe FileName Source #