Data.Conduit.VFS.Pure

This is intended primarily to be a drop-in testing mock for VFS implementations, but you may also find it useful within your program if you want to work with some hierarchically-organized data.

Individual read and write operations are atomic.

The FilePath values used in this VFS are split using splitPath and joined using </>, but are otherwise used directly: there is no concept of paths being "relative" or "absolute" for this VFS. It is also possible for a file and a directory to have the same name, since directories names are appended with /, as per splitPath. (This implementation detail is up for debate and may be changed in a future major release: please file an issue if you want to have a discussion around it.)

Documentation

data PureVFS m a

The basic implementation of the VFS.

Instances

MonadTrans PureVFS

Defined in Data.Conduit.VFS.Pure

Methods

lift :: Monad m => m a -> PureVFS m a

Monad m => Monad (PureVFS m)

Defined in Data.Conduit.VFS.Pure

Methods

(>>=) :: PureVFS m a -> (a -> PureVFS m b) -> PureVFS m b

(>>) :: PureVFS m a -> PureVFS m b -> PureVFS m b

return :: a -> PureVFS m a

fail :: String -> PureVFS m a

Functor m => Functor (PureVFS m)

Defined in Data.Conduit.VFS.Pure

Methods

fmap :: (a -> b) -> PureVFS m a -> PureVFS m b

(<$) :: a -> PureVFS m b -> PureVFS m a

MonadFail m => MonadFail (PureVFS m)

Defined in Data.Conduit.VFS.Pure

Methods

fail :: String -> PureVFS m a

Monad m => Applicative (PureVFS m)

Defined in Data.Conduit.VFS.Pure

Methods

pure :: a -> PureVFS m a

(<*>) :: PureVFS m (a -> b) -> PureVFS m a -> PureVFS m b

liftA2 :: (a -> b -> c) -> PureVFS m a -> PureVFS m b -> PureVFS m c

(*>) :: PureVFS m a -> PureVFS m b -> PureVFS m b

(<*) :: PureVFS m a -> PureVFS m b -> PureVFS m a

Monad m => VFSC (PureVFS m)

A class denoting that the type is usable as VFS conduits for reading and writing.

Defined in Data.Conduit.VFS.Pure

Methods

vfsTouchSink :: ConduitT (VFileType, FilePath) Void (PureVFS m) ()

Monad m => WriteVFSC (PureVFS m)

A class denoting that the type is usable as VFS conduits for writing.

Defined in Data.Conduit.VFS.Pure

Methods

vfsWriteSink :: ConduitT (FilePath, ByteString) Void (PureVFS m) ()

vfsWriteEitherSink :: ConduitT (Either FilePath ByteString) Void (PureVFS m) ()

vfsRemoveSink :: VFSSink (PureVFS m) ()

Monad m => ReadVFSC (PureVFS m)

Defined in Data.Conduit.VFS.Pure

Methods

vfsTypeC :: ConduitT FilePath (FilePath, Maybe VFileType) (PureVFS m) ()

vfsContentsC :: ConduitT FilePath (FilePath, ByteString) (PureVFS m) ()

vfsContentsEitherC :: ConduitT FilePath (Either FilePath ByteString) (PureVFS m) ()

vfsChildrenC :: VFSPipe (PureVFS m)

vfsChildFilesC :: VFSPipe (PureVFS m)

vfsChildDirsC :: VFSPipe (PureVFS m)

vfsDescendentsC :: VFSPipe (PureVFS m)

vfsDescFilesC :: VFSPipe (PureVFS m)

vfsDescDirsC :: VFSPipe (PureVFS m)

runPureVFS :: PureVFS m a -> m (a, PNode)

Given a PureVFS, run it in the local monad and return both the monadic return value and the root node of the VFS.

runPureVFS' :: Monad m => PureVFS m a -> m PNode

Given a PureVFS, run it in the local monad and return the root node of the VFS.

runPureVFS_ :: Monad m => PureVFS m a -> m ()

Given a PureVFS, run it in the local monad and disregard any results.