Waargonaut.Decode.Types

Types for the succinct data structure decoder

Documentation

type ParseFn = ByteString -> Either DecodeError Json

Convenience alias for the type of the function we will use to parse the input string into the Json structure.

type Cursor = GenericCursor ByteString CsPoppy1 (RangeMin CsPoppy1)

type CursorHistory = CursorHistory' Count

We define the index of our CursorHistory' to be the Count.

newtype Decoder f a

Decoder type that is used directly to convert Json structures to other data types.

Constructors

Decoder

Fields

• runDecoder :: ParseFn -> JCurs -> DecodeResultT Count DecodeError f a

Instances

MonadTrans Decoder

Defined in Waargonaut.Decode.Types

Methods

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

Monad f => MonadError DecodeError (Decoder f)

Defined in Waargonaut.Decode.Types

Methods

throwError :: DecodeError -> Decoder f a

catchError :: Decoder f a -> (DecodeError -> Decoder f a) -> Decoder f a

Monad f => Monad (Decoder f)

Defined in Waargonaut.Decode.Types

Methods

(>>=) :: Decoder f a -> (a -> Decoder f b) -> Decoder f b

(>>) :: Decoder f a -> Decoder f b -> Decoder f b

return :: a -> Decoder f a

Functor f => Functor (Decoder f)

Defined in Waargonaut.Decode.Types

Methods

fmap :: (a -> b) -> Decoder f a -> Decoder f b

(<$) :: a -> Decoder f b -> Decoder f a

Monad f => Applicative (Decoder f)

Defined in Waargonaut.Decode.Types

Methods

pure :: a -> Decoder f a

(<*>) :: Decoder f (a -> b) -> Decoder f a -> Decoder f b

liftA2 :: (a -> b -> c) -> Decoder f a -> Decoder f b -> Decoder f c

(*>) :: Decoder f a -> Decoder f b -> Decoder f b

(<*) :: Decoder f a -> Decoder f b -> Decoder f a

Monad f => Alt (Decoder f)

Defined in Waargonaut.Decode.Types

Methods

(<!>) :: Decoder f a -> Decoder f a -> Decoder f a

some :: Applicative (Decoder f) => Decoder f a -> Decoder f [a]

many :: Applicative (Decoder f) => Decoder f a -> Decoder f [a]

MFunctor Decoder

Defined in Waargonaut.Decode.Types

Methods

hoist :: forall m n (b :: k). Monad m => (forall a. m a -> n a) -> Decoder m b -> Decoder n b

newtype DecodeResult f a

Provide some of the type parameters that the underlying DecodeResultT requires. This contains the state and error management as we walk around our zipper and decode our JSON input.

Addtionally we keep our parsing function in a ReaderT such that it's accessible for all of the decoding steps.

Constructors

DecodeResult

Fields

• unDecodeResult :: ReaderT ParseFn (DecodeResultT Count DecodeError f) a

Instances

MMonad DecodeResult

Defined in Waargonaut.Decode.Types

Methods

embed :: forall (n :: Type -> Type) m b. Monad n => (forall a. m a -> DecodeResult n a) -> DecodeResult m b -> DecodeResult n b

MonadTrans DecodeResult

Defined in Waargonaut.Decode.Types

Methods

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

Monad f => MonadReader ParseFn (DecodeResult f)

Defined in Waargonaut.Decode.Types

Methods

ask :: DecodeResult f ParseFn

local :: (ParseFn -> ParseFn) -> DecodeResult f a -> DecodeResult f a

reader :: (ParseFn -> a) -> DecodeResult f a

Monad f => MonadState CursorHistory (DecodeResult f)

Defined in Waargonaut.Decode.Types

Methods

get :: DecodeResult f CursorHistory

put :: CursorHistory -> DecodeResult f ()

state :: (CursorHistory -> (a, CursorHistory)) -> DecodeResult f a

Monad f => MonadError DecodeError (DecodeResult f)

Defined in Waargonaut.Decode.Types

Methods

throwError :: DecodeError -> DecodeResult f a

catchError :: DecodeResult f a -> (DecodeError -> DecodeResult f a) -> DecodeResult f a

Monad f => Monad (DecodeResult f)

Defined in Waargonaut.Decode.Types

Methods

(>>=) :: DecodeResult f a -> (a -> DecodeResult f b) -> DecodeResult f b

(>>) :: DecodeResult f a -> DecodeResult f b -> DecodeResult f b

return :: a -> DecodeResult f a

Functor f => Functor (DecodeResult f)

Defined in Waargonaut.Decode.Types

Methods

fmap :: (a -> b) -> DecodeResult f a -> DecodeResult f b

(<$) :: a -> DecodeResult f b -> DecodeResult f a

Monad f => Applicative (DecodeResult f)

Defined in Waargonaut.Decode.Types

Methods

pure :: a -> DecodeResult f a

(<*>) :: DecodeResult f (a -> b) -> DecodeResult f a -> DecodeResult f b

liftA2 :: (a -> b -> c) -> DecodeResult f a -> DecodeResult f b -> DecodeResult f c

(*>) :: DecodeResult f a -> DecodeResult f b -> DecodeResult f b

(<*) :: DecodeResult f a -> DecodeResult f b -> DecodeResult f a

MFunctor DecodeResult

Defined in Waargonaut.Decode.Types

Methods

hoist :: forall m n (b :: k). Monad m => (forall a. m a -> n a) -> DecodeResult m b -> DecodeResult n b

newtype JCurs

Wrapper type for the SuccinctCursor

Constructors

JCurs

Fields

• unJCurs :: Cursor

Instances

JsonTypeAt JCurs

Defined in Waargonaut.Decode.Types

Methods

jsonTypeAtPosition :: Position -> JCurs -> Maybe JsonType

jsonTypeAt :: JCurs -> Maybe JsonType

Wrapped JCurs

Defined in Waargonaut.Decode.Types

Associated Types

type Unwrapped JCurs

Methods

_Wrapped' :: Iso' JCurs (Unwrapped JCurs)

JCurs ~ t => Rewrapped JCurs t

Defined in Waargonaut.Decode.Types

type Unwrapped JCurs

Defined in Waargonaut.Decode.Types

type Unwrapped JCurs = Cursor

mkCursor :: ByteString -> JCurs

Take a ByteString input and build an index of the JSON structure inside

jsonTypeAt :: JsonTypeAt a => a -> Maybe JsonType

data JsonType

Constructors

JsonTypeArray

JsonTypeBool

JsonTypeNull

JsonTypeNumber

JsonTypeObject

JsonTypeString

Instances

Eq JsonType

Defined in HaskellWorks.Data.Json.Standard.Cursor.Type

Methods

(==) :: JsonType -> JsonType -> Bool

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

Show JsonType

Defined in HaskellWorks.Data.Json.Standard.Cursor.Type

Methods

showsPrec :: Int -> JsonType -> ShowS

show :: JsonType -> String

showList :: [JsonType] -> ShowS

Generic JsonType

Defined in HaskellWorks.Data.Json.Standard.Cursor.Type

Associated Types

type Rep JsonType :: Type -> Type

Methods

from :: JsonType -> Rep JsonType x

to :: Rep JsonType x -> JsonType

type Rep JsonType

Defined in HaskellWorks.Data.Json.Standard.Cursor.Type

type Rep JsonType = D1 ('MetaData "JsonType" "HaskellWorks.Data.Json.Standard.Cursor.Type" "hw-json-standard-cursor-0.2.3.1-4USwUwyEQQHJJJZ5e4Ccq5" 'False) ((C1 ('MetaCons "JsonTypeArray" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "JsonTypeBool" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "JsonTypeNull" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "JsonTypeNumber" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "JsonTypeObject" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "JsonTypeString" 'PrefixI 'False) (U1 :: Type -> Type))))