Safe Haskell	None
Language	Haskell2010

Brick.Widgets.FileTree.Internal.Types

Synopsis

data FileKind
- = Dir
- | File
- | Error
data FileContext a = FC {
- flagged :: Bool
- path :: FilePath
- name :: String
- kind :: FileKind
- val :: a
}
data Config = Config {
- showSelection :: Bool
- previewDir :: Bool
}
data FileTree a = FT {
- parents :: Seq (SubTree a)
- selection :: Set FilePath
- context :: SubTree a
- config :: Config
- valLoader :: ValueLoader a
}
type SubTree a = Cofree (GenericList String Vector) (FileContext a)
buildParent :: FilePath -> ValueLoader a -> SubTree a -> IO (FileTree a)
newFileTree :: ValueLoader a -> FilePath -> IO (FileTree a)
defaultConfig :: Config

Documentation

data FileKind Source #

Constructors

Dir
File
Error

Instances

Eq FileKind Source #
Instance details Defined in Brick.Widgets.FileTree.Internal.Types Methods (==) :: FileKind -> FileKind -> Bool # (/=) :: FileKind -> FileKind -> Bool #
Ord FileKind Source #
Instance details Defined in Brick.Widgets.FileTree.Internal.Types Methods compare :: FileKind -> FileKind -> Ordering # (<) :: FileKind -> FileKind -> Bool # (<=) :: FileKind -> FileKind -> Bool # (>) :: FileKind -> FileKind -> Bool # (>=) :: FileKind -> FileKind -> Bool # max :: FileKind -> FileKind -> FileKind # min :: FileKind -> FileKind -> FileKind #
Show FileKind Source #
Instance details Defined in Brick.Widgets.FileTree.Internal.Types Methods showsPrec :: Int -> FileKind -> ShowS # show :: FileKind -> String # showList :: [FileKind] -> ShowS #

data FileContext a Source #

Constructors

FC
Fields flagged :: Bool path :: FilePath name :: String kind :: FileKind val :: a

data Config Source #

Constructors

Config
Fields showSelection :: Bool previewDir :: Bool

data FileTree a Source #

Represents all the state required to interact with or display a filetree

Constructors

FT
Fields parents :: Seq (SubTree a) selection :: Set FilePath context :: SubTree a config :: Config valLoader :: ValueLoader a

type SubTree a = Cofree (GenericList String Vector) (FileContext a) Source #

buildParent :: FilePath -> ValueLoader a -> SubTree a -> IO (FileTree a) Source #

newFileTree :: ValueLoader a -> FilePath -> IO (FileTree a) Source #

Create a new FileTree situated at the given FilePath

The given ValueLoader will be used to load additional context for each filepath (dirs AND files). It will be called lazily using unsafeInterleaveIO when the value itself is accessed (if ever).

defaultConfig :: Config Source #