Copyright	(c) 2018 Drew Hess
License	BSD3
Maintainer	Drew Hess <src@drewhess.com>
Stability	experimental
Portability	non-portable
Safe Haskell	Safe
Language	Haskell2010

System.GPIO.Linux.Sysfs.Mock.Internal

Contents

Mock filesystem types
Mock filesystem operations

Description

Types and functions to emulate a (pure) rudimentary Posix-style filesystem.

This module was written for internal use only. Its interface may change at any time. Documentation in this module is sparse, by design.

N.B.: This mock filesystem implementation was written with the intention of doing only just enough to emulate the operations needed by the MonadSysfs type class. Though it may be possible to use this implementation for other purposes, it has neither been designed nor tested for that. Use at your own risk and please do not submit requests for addtional functionality.

Synopsis

type Name = FilePath
data File = File {
- _fileName :: !Name
- _fileType :: !FileType
}
data FileType
- = Constant [ByteString]
- | Export
- | Unexport
- | Value Pin
- | Direction Pin
- | Edge Pin
- | ActiveLow Pin
data DirNode = DirNode {
- _dirNodeName :: !Name
- _files :: [File]
}
type Directory = Tree DirNode
directory :: Name -> [File] -> [Directory] -> Directory
dirName :: Directory -> Name
files :: Directory -> [File]
dirNode :: Directory -> DirNode
subdirs :: Directory -> [Directory]
data MockFSCrumb = MockFSCrumb {
- _node :: DirNode
- _pred :: [Directory]
- _succ :: [Directory]
}
data MockFSZipper = MockFSZipper {
- _cwd :: Directory
- _crumbs :: [MockFSCrumb]
}
cd :: FilePath -> MockFSZipper -> Either IOError MockFSZipper
pathFromRoot :: MockFSZipper -> FilePath
findFile :: Name -> Directory -> Maybe FileType
mkdir :: Name -> MockFSZipper -> Either IOError MockFSZipper
mkfile :: Name -> FileType -> Bool -> MockFSZipper -> Either IOError MockFSZipper
rmdir :: Name -> MockFSZipper -> Either IOError MockFSZipper
rmfile :: Name -> MockFSZipper -> Either IOError MockFSZipper

Mock filesystem types

type Name = FilePath Source #

data File Source #

Constructors

File
Fields _fileName :: !Name _fileType :: !FileType

Instances

Eq File Source #
Instance details Defined in System.GPIO.Linux.Sysfs.Mock.Internal Methods (==) :: File -> File -> Bool # (/=) :: File -> File -> Bool #
Show File Source #
Instance details Defined in System.GPIO.Linux.Sysfs.Mock.Internal Methods showsPrec :: Int -> File -> ShowS # show :: File -> String # showList :: [File] -> ShowS #

data FileType Source #

Constructors

Constant [ByteString]
Export
Unexport
Value Pin
Direction Pin
Edge Pin
ActiveLow Pin

Instances

Eq FileType Source #
Instance details Defined in System.GPIO.Linux.Sysfs.Mock.Internal Methods (==) :: FileType -> FileType -> Bool # (/=) :: FileType -> FileType -> Bool #
Show FileType Source #
Instance details Defined in System.GPIO.Linux.Sysfs.Mock.Internal Methods showsPrec :: Int -> FileType -> ShowS # show :: FileType -> String # showList :: [FileType] -> ShowS #

data DirNode Source #

Constructors

DirNode
Fields _dirNodeName :: !Name _files :: [File]

Instances

Eq DirNode Source #
Instance details Defined in System.GPIO.Linux.Sysfs.Mock.Internal Methods (==) :: DirNode -> DirNode -> Bool # (/=) :: DirNode -> DirNode -> Bool #
Show DirNode Source #
Instance details Defined in System.GPIO.Linux.Sysfs.Mock.Internal Methods showsPrec :: Int -> DirNode -> ShowS # show :: DirNode -> String # showList :: [DirNode] -> ShowS #

type Directory = Tree DirNode Source #

directory :: Name -> [File] -> [Directory] -> Directory Source #

dirName :: Directory -> Name Source #

files :: Directory -> [File] Source #

dirNode :: Directory -> DirNode Source #

subdirs :: Directory -> [Directory] Source #

data MockFSCrumb Source #

Constructors

MockFSCrumb
Fields _node :: DirNode _pred :: [Directory] _succ :: [Directory]

Instances

Eq MockFSCrumb Source #
Instance details Defined in System.GPIO.Linux.Sysfs.Mock.Internal Methods (==) :: MockFSCrumb -> MockFSCrumb -> Bool # (/=) :: MockFSCrumb -> MockFSCrumb -> Bool #
Show MockFSCrumb Source #
Instance details Defined in System.GPIO.Linux.Sysfs.Mock.Internal Methods showsPrec :: Int -> MockFSCrumb -> ShowS # show :: MockFSCrumb -> String # showList :: [MockFSCrumb] -> ShowS #

data MockFSZipper Source #

An opaque type representing the current state of the mock sysfs filesystem. Because the constructor is not exported via the public interface, you cannot create these directly, but you can manipulate them using the exposed mock sysfs operations and then pass those MockFSZippers around.

Constructors

MockFSZipper
Fields _cwd :: Directory _crumbs :: [MockFSCrumb]

Instances

Eq MockFSZipper Source #
Instance details Defined in System.GPIO.Linux.Sysfs.Mock.Internal Methods (==) :: MockFSZipper -> MockFSZipper -> Bool # (/=) :: MockFSZipper -> MockFSZipper -> Bool #
Show MockFSZipper Source #
Instance details Defined in System.GPIO.Linux.Sysfs.Mock.Internal Methods showsPrec :: Int -> MockFSZipper -> ShowS # show :: MockFSZipper -> String # showList :: [MockFSZipper] -> ShowS #

Mock filesystem operations

cd :: FilePath -> MockFSZipper -> Either IOError MockFSZipper Source #

pathFromRoot :: MockFSZipper -> FilePath Source #

findFile :: Name -> Directory -> Maybe FileType Source #

mkdir :: Name -> MockFSZipper -> Either IOError MockFSZipper Source #

mkfile :: Name -> FileType -> Bool -> MockFSZipper -> Either IOError MockFSZipper Source #

rmdir :: Name -> MockFSZipper -> Either IOError MockFSZipper Source #

rmfile :: Name -> MockFSZipper -> Either IOError MockFSZipper Source #