Servant.Static.TH.Internal.FileTree

Read a directory and the contents of all the files in it as a FileTree.

Documentation

data FileTree

This tree structure represents the directory structure on disk.

Constructors

FileTreeFile FilePath ByteString

A file with it's FilePath and contents as a ByteString.

FileTreeDir FilePath (NonEmpty FileTree)

A directory with it's FilePath and the files under it.

Instances

Eq FileTree

Defined in Servant.Static.TH.Internal.FileTree

Methods

(==) :: FileTree -> FileTree -> Bool

(/=) :: FileTree -> FileTree -> Bool

Read FileTree

Defined in Servant.Static.TH.Internal.FileTree

Methods

readsPrec :: Int -> ReadS FileTree

readList :: ReadS [FileTree]

readPrec :: ReadPrec FileTree

readListPrec :: ReadPrec [FileTree]

Show FileTree

Defined in Servant.Static.TH.Internal.FileTree

Methods

showsPrec :: Int -> FileTree -> ShowS

show :: FileTree -> String

showList :: [FileTree] -> ShowS

data FileType

This is a simple version of FileTree, just used for tagging a given FilePath as a directory or a file.

Constructors

FileTypeFile FilePath

FileTypeDir FilePath

Instances

Eq FileType

Defined in Servant.Static.TH.Internal.FileTree

Methods

(==) :: FileType -> FileType -> Bool

(/=) :: FileType -> FileType -> Bool

Read FileType

Defined in Servant.Static.TH.Internal.FileTree

Methods

readsPrec :: Int -> ReadS FileType

readList :: ReadS [FileType]

readPrec :: ReadPrec FileType

readListPrec :: ReadPrec [FileType]

Show FileType

Defined in Servant.Static.TH.Internal.FileTree

Methods

showsPrec :: Int -> FileType -> ShowS

show :: FileType -> String

showList :: [FileType] -> ShowS

getFileType :: FilePath -> IO FileType

Get the FileType for a given FilePath. Calls fail if it is not a file or a directory.

fileTypeToFileTree :: FileType -> IO (Maybe FileTree)

Convert a FileType to a FileTree. Return Nothing if the input FileType is FileTypeDir, and that directory is empty.

getFileTree :: FilePath -> IO [FileTree]

Convert an input directory FilePath to a FileTree. Fails if the input directory FilePath is not a directory.

getFileTreeIgnoreEmpty :: FilePath -> IO (NonEmpty FileTree)

Just like getFileTree, but returns an error with fail if the input directory is empty.