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

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 #
Methods (==) :: FilePath -> FilePath -> Bool # (/=) :: FilePath -> FilePath -> Bool #
Ord FilePath Source #
Methods compare :: FilePath -> FilePath -> Ordering # (<) :: FilePath -> FilePath -> Bool # (<=) :: FilePath -> FilePath -> Bool # (>) :: FilePath -> FilePath -> Bool # (>=) :: FilePath -> FilePath -> Bool # max :: FilePath -> FilePath -> FilePath # min :: FilePath -> FilePath -> FilePath #
Show FilePath Source #
Methods showsPrec :: Int -> FilePath -> ShowS # show :: FilePath -> String # showList :: [FilePath] -> ShowS #
IsString FilePath Source #
Methods fromString :: String -> FilePath #
Path FilePath Source #
Associated Types type PathEnt FilePath :: * Source # type PathPrefix FilePath :: * Source # type PathSuffix FilePath :: * 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 #
type PathEnt FilePath = FileName
type PathPrefix FilePath Source #
type PathPrefix FilePath = Relativity
type PathSuffix FilePath Source #
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 #
Methods (==) :: Relativity -> Relativity -> Bool # (/=) :: Relativity -> Relativity -> Bool #
Show Relativity Source #
Methods showsPrec :: Int -> Relativity -> ShowS # show :: Relativity -> String # showList :: [Relativity] -> ShowS #

data FileName Source #

A filename (or path entity) in the FilePath

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

Instances

Eq FileName Source #
Methods (==) :: FileName -> FileName -> Bool # (/=) :: FileName -> FileName -> Bool #
Show FileName Source #
Methods showsPrec :: Int -> FileName -> ShowS # show :: FileName -> String # showList :: [FileName] -> ShowS #
IsString FileName Source #
Methods fromString :: String -> FileName #
Semigroup FileName Source #
Methods (<>) :: FileName -> FileName -> FileName # sconcat :: NonEmpty FileName -> FileName # stimes :: Integral b => b -> FileName -> FileName #
Monoid FileName Source #
Methods mempty :: FileName # mappend :: FileName -> FileName -> FileName # mconcat :: [FileName] -> FileName #

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 #