Data.JSON.Directory

Documentation

decodeDirectory :: (FromJSON a, MonadIO io) => FilePath -> io (Either String a)

Takes a directory and decodes it using a FromJSON instance. Each entry in the directory becomes a key, and the contents become the corresponding value.

• Directories are recursed into.
• Files ending in .json are decoded as JSON values.
• Everything else is assumed to be a valid unicode string.

This function can throw IO exceptions as well as a ModifiedWhileReading exception if the modification time changes during processing.

Uses defaultRules

decodeDirectory' :: (FromJSON a, MonadIO io) => [Rule] -> FilePath -> io (Either String a)

Like decodeDirectory but you get to specify the rules.

data Rule

How to interpret a file.

Constructors

Rule

Fields

• predicate :: FilePath -> Bool

  A predicate to see if this rule applies.

• jsonKey :: FilePath -> Key

  A function to transform the filename into a JSON key value

• parser :: FilePath -> IO (IResult Value)

  Turn a file into a Value. The JSONPath in the IResult will be merged into the correct location.

data IResult a

The internal result of running a Parser.

Constructors

IError JSONPath String

ISuccess a

Instances

MonadFail IResult

Defined in Data.Aeson.Types.Internal

Methods

fail :: String -> IResult a

Foldable IResult

Defined in Data.Aeson.Types.Internal

Methods

fold :: Monoid m => IResult m -> m

foldMap :: Monoid m => (a -> m) -> IResult a -> m

foldMap' :: Monoid m => (a -> m) -> IResult a -> m

foldr :: (a -> b -> b) -> b -> IResult a -> b

foldr' :: (a -> b -> b) -> b -> IResult a -> b

foldl :: (b -> a -> b) -> b -> IResult a -> b

foldl' :: (b -> a -> b) -> b -> IResult a -> b

foldr1 :: (a -> a -> a) -> IResult a -> a

foldl1 :: (a -> a -> a) -> IResult a -> a

toList :: IResult a -> [a]

null :: IResult a -> Bool

length :: IResult a -> Int

elem :: Eq a => a -> IResult a -> Bool

maximum :: Ord a => IResult a -> a

minimum :: Ord a => IResult a -> a

sum :: Num a => IResult a -> a

product :: Num a => IResult a -> a

Traversable IResult

Defined in Data.Aeson.Types.Internal

Methods

traverse :: Applicative f => (a -> f b) -> IResult a -> f (IResult b)

sequenceA :: Applicative f => IResult (f a) -> f (IResult a)

mapM :: Monad m => (a -> m b) -> IResult a -> m (IResult b)

sequence :: Monad m => IResult (m a) -> m (IResult a)

Alternative IResult

Defined in Data.Aeson.Types.Internal

Methods

empty :: IResult a

(<|>) :: IResult a -> IResult a -> IResult a

some :: IResult a -> IResult [a]

many :: IResult a -> IResult [a]

Applicative IResult

Defined in Data.Aeson.Types.Internal

Methods

pure :: a -> IResult a

(<*>) :: IResult (a -> b) -> IResult a -> IResult b

liftA2 :: (a -> b -> c) -> IResult a -> IResult b -> IResult c

(*>) :: IResult a -> IResult b -> IResult b

(<*) :: IResult a -> IResult b -> IResult a

Functor IResult

Defined in Data.Aeson.Types.Internal

Methods

fmap :: (a -> b) -> IResult a -> IResult b

(<$) :: a -> IResult b -> IResult a

Monad IResult

Defined in Data.Aeson.Types.Internal

Methods

(>>=) :: IResult a -> (a -> IResult b) -> IResult b

(>>) :: IResult a -> IResult b -> IResult b

return :: a -> IResult a

MonadPlus IResult

Defined in Data.Aeson.Types.Internal

Methods

mzero :: IResult a

mplus :: IResult a -> IResult a -> IResult a

Monoid (IResult a)

Defined in Data.Aeson.Types.Internal

Methods

mempty :: IResult a

mappend :: IResult a -> IResult a -> IResult a

mconcat :: [IResult a] -> IResult a

Semigroup (IResult a)

Defined in Data.Aeson.Types.Internal

Methods

(<>) :: IResult a -> IResult a -> IResult a

sconcat :: NonEmpty (IResult a) -> IResult a

stimes :: Integral b => b -> IResult a -> IResult a

Show a => Show (IResult a)

Defined in Data.Aeson.Types.Internal

Methods

showsPrec :: Int -> IResult a -> ShowS

show :: IResult a -> String

showList :: [IResult a] -> ShowS

NFData a => NFData (IResult a)

Defined in Data.Aeson.Types.Internal

Methods

rnf :: IResult a -> ()

Eq a => Eq (IResult a)

Defined in Data.Aeson.Types.Internal

Methods

(==) :: IResult a -> IResult a -> Bool

(/=) :: IResult a -> IResult a -> Bool

defaultRules :: [Rule]

Some sane default rules. Attempts do do jsonRule and falls back to textRule

jsonRule :: Rule

A rule that reads .json files as JSON.

textRule :: Rule

A rule that reads any file into a JSON string.

idecodeStrict :: FromJSON a => ByteString -> IResult a

data ModifiedWhileReading

Instances

Exception ModifiedWhileReading

Defined in Data.JSON.Directory

Methods

toException :: ModifiedWhileReading -> SomeException

fromException :: SomeException -> Maybe ModifiedWhileReading

displayException :: ModifiedWhileReading -> String

Show ModifiedWhileReading

Defined in Data.JSON.Directory

Methods

showsPrec :: Int -> ModifiedWhileReading -> ShowS

show :: ModifiedWhileReading -> String

showList :: [ModifiedWhileReading] -> ShowS

data NoRuleFor

Instances

Exception NoRuleFor

Defined in Data.JSON.Directory

Methods

toException :: NoRuleFor -> SomeException

fromException :: SomeException -> Maybe NoRuleFor

displayException :: NoRuleFor -> String

Show NoRuleFor

Defined in Data.JSON.Directory

Methods

showsPrec :: Int -> NoRuleFor -> ShowS

show :: NoRuleFor -> String

showList :: [NoRuleFor] -> ShowS