JSONIncrementalDecoder

A DSL for specification of a single-pass incremental and possibly partial parser of JSON.

Execution

valueToSupplementedParser :: Value a -> Supplemented Parser a

Converts the Value specification into a Supplemented Attoparsec Parser.

valueToParser :: Value a -> Parser (a, Parser ())

Essentially just a helper, which is the same as

runSupplemented . valueToSupplementedParser

valueToByteStringToEither :: Value a -> ByteString -> Either Text a

Converts the Value specification into a function, which decodes a strict ByteString.

valueToLazyByteStringToEither :: Value a -> ByteString -> Either Text a

Converts the Value specification into a function, which decodes a strict LazyByteString.

Value

data Value a

Instances

Functor Value

Monoid (Value a)

Provides support for alternatives.

E.g,

fmap Left bool <> fmap Right string

will succeed for either a Boolean or String value.

null :: Value ()

nullable :: Value a -> Value (Maybe a)

bool :: Value Bool

numberAsInt :: Value Int

numberAsInteger :: Value Integer

numberAsDouble :: Value Double

numberAsScientific :: Value Scientific

string :: Value Text

objectRows :: ObjectRows a -> Value a

objectLookup :: ObjectLookup a -> Value a

arrayElements :: ArrayElements a -> Value a

ObjectRows

data ObjectRows a

Instances

Monad ObjectRows

Functor ObjectRows

Applicative ObjectRows

Alternative ObjectRows

MonadPlus ObjectRows

row :: (a -> b -> c) -> Matcher Text a -> Value b -> ObjectRows c

anyRow :: ObjectRows ()

ObjectLookup

data ObjectLookup a

Instances

Functor ObjectLookup

Applicative ObjectLookup

atKey :: Text -> Value a -> ObjectLookup a

ArrayElements

data ArrayElements a

Instances

Monad ArrayElements

Functor ArrayElements

Applicative ArrayElements

Alternative ArrayElements

MonadPlus ArrayElements

element :: Value a -> ArrayElements a

anyElement :: ArrayElements ()

Matcher

data Matcher a b :: * -> * -> *

A composable abstraction for checking or converting a context value.

Instances

Arrow Matcher

Profunctor Matcher

Category * Matcher

Monad (Matcher a)

Functor (Matcher a)

Applicative (Matcher a)

Alternative (Matcher a)

MonadPlus (Matcher a)

equals :: Eq a => a -> Matcher a ()

Tests the matched value on equality with the provided value.

satisfies :: (a -> Bool) -> Matcher a ()

Checks whether the matched value satisfies the provided predicate.

converts :: (a -> Either Text b) -> Matcher a b

Tries to convert the matched value to an output value, with Either encoding the success or failure of the conversion.

whatever :: Matcher a ()

The matcher, which is always satisfied.