System.IO.HVFS.InstanceHelpers

Utilities for creating instances of the items defined in System.IO.HVFS.

HVFSStat objects

data SimpleStat

A simple System.IO.HVFS.HVFSStat class that assumes that everything is either a file or a directory.

Constructors

SimpleStat

Fields

• isFile :: Bool

  True if file, False if directory

• fileSize :: FileOffset

  Set to 0 if unknown or a directory

Instances

Eq SimpleStat

Methods

(==) :: SimpleStat -> SimpleStat -> Bool

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

Show SimpleStat

Methods

showsPrec :: Int -> SimpleStat -> ShowS

show :: SimpleStat -> String

showList :: [SimpleStat] -> ShowS

HVFSStat SimpleStat

Methods

vDeviceID :: SimpleStat -> DeviceID

vFileID :: SimpleStat -> FileID

vFileMode :: SimpleStat -> FileMode

vLinkCount :: SimpleStat -> LinkCount

vFileOwner :: SimpleStat -> UserID

vFileGroup :: SimpleStat -> GroupID

vSpecialDeviceID :: SimpleStat -> DeviceID

vFileSize :: SimpleStat -> FileOffset

vAccessTime :: SimpleStat -> EpochTime

vModificationTime :: SimpleStat -> EpochTime

vStatusChangeTime :: SimpleStat -> EpochTime

vIsBlockDevice :: SimpleStat -> Bool

vIsCharacterDevice :: SimpleStat -> Bool

vIsNamedPipe :: SimpleStat -> Bool

vIsRegularFile :: SimpleStat -> Bool

vIsDirectory :: SimpleStat -> Bool

vIsSymbolicLink :: SimpleStat -> Bool

vIsSocket :: SimpleStat -> Bool

HVFS objects & types

MemoryVFS

data MemoryVFS

An in-memory read/write filesystem. Think of it as a dynamically resizable ramdisk written in Haskell.

Instances

Show MemoryVFS

Methods

showsPrec :: Int -> MemoryVFS -> ShowS

show :: MemoryVFS -> String

showList :: [MemoryVFS] -> ShowS

HVFSOpenable MemoryVFS

Methods

vOpen :: MemoryVFS -> FilePath -> IOMode -> IO HVFSOpenEncap

vReadFile :: MemoryVFS -> FilePath -> IO String

vWriteFile :: MemoryVFS -> FilePath -> String -> IO ()

vOpenBinaryFile :: MemoryVFS -> FilePath -> IOMode -> IO HVFSOpenEncap

HVFS MemoryVFS

Methods

vGetCurrentDirectory :: MemoryVFS -> IO FilePath

vSetCurrentDirectory :: MemoryVFS -> FilePath -> IO ()

vGetDirectoryContents :: MemoryVFS -> FilePath -> IO [FilePath]

vDoesFileExist :: MemoryVFS -> FilePath -> IO Bool

vDoesDirectoryExist :: MemoryVFS -> FilePath -> IO Bool

vDoesExist :: MemoryVFS -> FilePath -> IO Bool

vCreateDirectory :: MemoryVFS -> FilePath -> IO ()

vRemoveDirectory :: MemoryVFS -> FilePath -> IO ()

vRenameDirectory :: MemoryVFS -> FilePath -> FilePath -> IO ()

vRemoveFile :: MemoryVFS -> FilePath -> IO ()

vRenameFile :: MemoryVFS -> FilePath -> FilePath -> IO ()

vGetFileStatus :: MemoryVFS -> FilePath -> IO HVFSStatEncap

vGetSymbolicLinkStatus :: MemoryVFS -> FilePath -> IO HVFSStatEncap

vGetModificationTime :: MemoryVFS -> FilePath -> IO ClockTime

vRaiseError :: MemoryVFS -> IOErrorType -> String -> Maybe FilePath -> IO c

vCreateSymbolicLink :: MemoryVFS -> FilePath -> FilePath -> IO ()

vReadSymbolicLink :: MemoryVFS -> FilePath -> IO FilePath

vCreateLink :: MemoryVFS -> FilePath -> FilePath -> IO ()

newMemoryVFS :: [MemoryNode] -> IO MemoryVFS

Create a new MemoryVFS object from an existing tree. An empty filesystem may be created by using [] for the parameter.

newMemoryVFSRef :: IORef [MemoryNode] -> IO MemoryVFS

Create a new MemoryVFS object using an IORef to an existing tree.

type MemoryNode = (String, MemoryEntry)

The basic node of a MemoryVFS. The String corresponds to the filename, and the entry to the contents.

data MemoryEntry

The content of a file or directory in a MemoryVFS.

Constructors

MemoryDirectory [MemoryNode]

MemoryFile String

Instances

Eq MemoryEntry

Methods

(==) :: MemoryEntry -> MemoryEntry -> Bool

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

Show MemoryEntry

Methods

showsPrec :: Int -> MemoryEntry -> ShowS

show :: MemoryEntry -> String

showList :: [MemoryEntry] -> ShowS

Utilities

nice_slice :: String -> [String]

Similar to NameManip but the first element won't be /.

nice_slice "/" -> []
nice_slice "/foo/bar" -> ["foo", "bar"]

getFullPath :: HVFS a => a -> String -> IO String

Gets a full path, after investigating the cwd.

getFullSlice :: HVFS a => a -> String -> IO [String]

Gets the full path via getFullPath, then splits it via nice_slice.