System.Directory.Layout.Interpreter

A bunch of Layout description interpreters

Documentation

pretty :: Layout a -> String

Pretty print the directory layout

examples :: FilePath -> Layout a -> Spec

Interpret the directory layout as a Spec

fromErrors :: Foldable t => t e -> Either (NonEmpty e) ()

Construct Validation value from the list of errors

>>> fromErrors []
Right ()

>>> fromErrors Nothing
Right ()

>>> fromErrors "hello"
Left ('h' :| "ello")

>>> fromErrors (Just "hello")
Left ("hello" :| [])

fit :: FilePath -> Layout a -> IO (Either (NonEmpty FitError) ())

Check the real directory layout fits the description

data FitError

Errors encountered while running fit

Constructors

FitBadFileContents FilePath FitContentsError

FitBadLinkSource FilePath String String

FitBadOwnerUser FilePath User User

FitBadOwnerGroup FilePath Group Group

FitBadFileMode FilePath FileMode FileMode

FitIOException FilePath IOErrorType

Instances

Eq FitError

Show FitError

Typeable FitError

Generic FitError

Exception FitError

data FitContentsError

Expected/actual file contents mismatch

Constructors

FitBadBinary ByteString ByteString

FitBadText Text Text

FitBadCopyOf FilePath

Instances

Eq FitContentsError

Typeable FitContentsError

Generic FitContentsError

make :: FilePath -> Layout a -> IO (Either (NonEmpty MakeError) ())

Make the real directory layout from the description

remake :: FilePath -> Layout a -> IO (Either (NonEmpty MakeError) ())

Make the real directory layout from the description removing any previous contents

data MakeError

Errors encountered while running make

Constructors

MakeIOException FilePath IOErrorType

Instances

Eq MakeError

Show MakeError

Typeable MakeError

Generic MakeError

Exception MakeError