Safe Haskell	None
Language	Haskell2010

Path.Internal

Description

Internal types and functions.

Synopsis

Documentation

newtype Path b t Source #

Path of some base and type.

The type variables are:

b — base, the base location of the path; absolute or relative.
t — type, whether file or directory.

Internally is a string. The string can be of two formats only:

File format: file.txt, foo/bar.txt, /foo/bar.txt
Directory format: foo/, /foo/bar/

All directories end in a trailing separator. There are no duplicate path separators //, no .., no ./, no ~/, etc.

Constructors

Path FilePath

Instances

Eq (Path b t) Source #	String equality. The following property holds: show x == show y ≡ x == y
Methods (==) :: Path b t -> Path b t -> Bool # (/=) :: Path b t -> Path b t -> Bool #
Ord (Path b t) Source #	String ordering. The following property holds: show x `compare` show y ≡ x `compare` y
Methods compare :: Path b t -> Path b t -> Ordering # (<) :: Path b t -> Path b t -> Bool # (<=) :: Path b t -> Path b t -> Bool # (>) :: Path b t -> Path b t -> Bool # (>=) :: Path b t -> Path b t -> Bool # max :: Path b t -> Path b t -> Path b t # min :: Path b t -> Path b t -> Path b t #
Show (Path b t) Source #	Same as 'show . Path.toFilePath'. The following property holds: x == y ≡ show x == show y
Methods showsPrec :: Int -> Path b t -> ShowS # show :: Path b t -> String # showList :: [Path b t] -> ShowS #
Hashable (Path b t) Source #
Methods hashWithSalt :: Int -> Path b t -> Int # hash :: Path b t -> Int #
ToJSON (Path b t) Source #
Methods toJSON :: Path b t -> Value # toEncoding :: Path b t -> Encoding # toJSONList :: [Path b t] -> Value # toEncodingList :: [Path b t] -> Encoding #
FromJSON (Path Rel Dir) #
Methods parseJSON :: Value -> Parser (Path Rel Dir) # parseJSONList :: Value -> Parser [Path Rel Dir] #
FromJSON (Path Rel File) #
Methods parseJSON :: Value -> Parser (Path Rel File) # parseJSONList :: Value -> Parser [Path Rel File] #
FromJSON (Path Abs Dir) #
Methods parseJSON :: Value -> Parser (Path Abs Dir) # parseJSONList :: Value -> Parser [Path Abs Dir] #
FromJSON (Path Abs File) #
Methods parseJSON :: Value -> Parser (Path Abs File) # parseJSONList :: Value -> Parser [Path Abs File] #
NFData (Path b t) Source #
Methods rnf :: Path b t -> () #

hasParentDir :: FilePath -> Bool Source #

Helper function: check if the filepath has any parent directories in it. This handles the logic of checking for different path separators on Windows.

relRootFP :: FilePath Source #

Normalized file path representation for the relative path root

toFilePath :: Path b t -> FilePath Source #

Convert to a FilePath type.

All directories have a trailing slash, so if you want no trailing slash, you can use dropTrailingPathSeparator from the filepath package.