Copyright	(C) 2016-2026 David M. Johnson
License	BSD3-style (see the file LICENSE)
Maintainer	David M. Johnson <code@dmj.io>
Stability	experimental
Portability	non-portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Miso.JSON.Types

Contents

Types

Description

Overview

Miso.JSON.Types defines the two core types used throughout miso's JSON support:

Value — an RFC 8259-compliant JSON value. Used as the intermediate representation in event decoders (Miso.Event.Decoder) and in ToJSVal / FromJSVal marshalling.
Result — a lightweight error monad (Success a | Error MisoString) used by JSON parsers to report decode failures. It has full Functor, Applicative, Monad, MonadFail, Alternative, Foldable, and Traversable instances.

This module was ported from https://github.com/dmjio/json-test by @ners.

Value constructors

data Value
  = Number Double          -- JSON number
  | Bool   Bool            -- JSON boolean
  | String MisoString   -- JSON string
  | Array  [Value]       -- JSON array
  | Object (Object)  -- JSON object (Map MisoString Value)
  | Null                   -- JSON null

Types

data Value Source #

Constructors

Number Double
Bool Bool
String MisoString
Array [Value]
Object (Map MisoString Value)
Null

Instances

Instances details

IsString Value Source #
Instance details Defined in Miso.JSON.Types Methods fromString :: String -> Value #
Show Value Source #
Instance details Defined in Miso.JSON.Types Methods showsPrec :: Int -> Value -> ShowS # show :: Value -> String # showList :: [Value] -> ShowS #
Eq Value Source #
Instance details Defined in Miso.JSON.Types Methods (==) :: Value -> Value -> Bool # (/=) :: Value -> Value -> Bool #
FromJSVal Value Source #
Instance details Defined in Miso.DSL Methods fromJSVal :: JSVal -> IO (Maybe Value) Source # fromJSValUnchecked :: JSVal -> IO Value Source #
ToJSVal Value Source #
Instance details Defined in Miso.DSL Methods toJSVal :: Value -> IO JSVal Source #
FromJSON Value Source #
Instance details Defined in Miso.JSON Methods parseJSON :: Value -> Parser Value Source #
ToJSON Value Source #
Instance details Defined in Miso.JSON Methods toJSON :: Value -> Value Source # toJSONList :: [Value] -> Value
FromMisoString Value Source #
Instance details Defined in Miso.JSON Methods fromMisoStringEither :: MisoString -> Either String Value Source #
ToMisoString Value Source #
Instance details Defined in Miso.JSON Methods toMisoString :: Value -> MisoString Source #

data Result a Source #

Constructors

Success a
Error MisoString

Instances

Instances details

Alternative Result Source #
Instance details Defined in Miso.JSON.Types Methods empty :: Result a # (<\|>) :: Result a -> Result a -> Result a # some :: Result a -> Result [a] # many :: Result a -> Result [a] #
Applicative Result Source #
Instance details Defined in Miso.JSON.Types Methods pure :: a -> Result a # (<>) :: Result (a -> b) -> Result a -> Result b # liftA2 :: (a -> b -> c) -> Result a -> Result b -> Result c # (>) :: Result a -> Result b -> Result b # (<*) :: Result a -> Result b -> Result a #
Functor Result Source #
Instance details Defined in Miso.JSON.Types Methods fmap :: (a -> b) -> Result a -> Result b # (<$) :: a -> Result b -> Result a #
Monad Result Source #
Instance details Defined in Miso.JSON.Types Methods (>>=) :: Result a -> (a -> Result b) -> Result b # (>>) :: Result a -> Result b -> Result b # return :: a -> Result a #
MonadPlus Result Source #
Instance details Defined in Miso.JSON.Types Methods mzero :: Result a # mplus :: Result a -> Result a -> Result a #
MonadFail Result Source #
Instance details Defined in Miso.JSON.Types Methods fail :: String -> Result a #
Foldable Result Source #
Instance details Defined in Miso.JSON.Types Methods fold :: Monoid m => Result m -> m # foldMap :: Monoid m => (a -> m) -> Result a -> m # foldMap' :: Monoid m => (a -> m) -> Result a -> m # foldr :: (a -> b -> b) -> b -> Result a -> b # foldr' :: (a -> b -> b) -> b -> Result a -> b # foldl :: (b -> a -> b) -> b -> Result a -> b # foldl' :: (b -> a -> b) -> b -> Result a -> b # foldr1 :: (a -> a -> a) -> Result a -> a # foldl1 :: (a -> a -> a) -> Result a -> a # toList :: Result a -> [a] # null :: Result a -> Bool # length :: Result a -> Int # elem :: Eq a => a -> Result a -> Bool # maximum :: Ord a => Result a -> a # minimum :: Ord a => Result a -> a # sum :: Num a => Result a -> a # product :: Num a => Result a -> a #
Traversable Result Source #
Instance details Defined in Miso.JSON.Types Methods traverse :: Applicative f => (a -> f b) -> Result a -> f (Result b) # sequenceA :: Applicative f => Result (f a) -> f (Result a) # mapM :: Monad m => (a -> m b) -> Result a -> m (Result b) # sequence :: Monad m => Result (m a) -> m (Result a) #
Monoid (Result a) Source #
Instance details Defined in Miso.JSON.Types Methods mempty :: Result a # mappend :: Result a -> Result a -> Result a # mconcat :: [Result a] -> Result a #
Semigroup (Result a) Source #
Instance details Defined in Miso.JSON.Types Methods (<>) :: Result a -> Result a -> Result a # sconcat :: NonEmpty (Result a) -> Result a # stimes :: Integral b => b -> Result a -> Result a #
Show a => Show (Result a) Source #
Instance details Defined in Miso.JSON.Types Methods showsPrec :: Int -> Result a -> ShowS # show :: Result a -> String # showList :: [Result a] -> ShowS #
Eq a => Eq (Result a) Source #
Instance details Defined in Miso.JSON.Types Methods (==) :: Result a -> Result a -> Bool # (/=) :: Result a -> Result a -> Bool #

type Pair = (MisoString, Value) Source #

type Object = Map MisoString Value Source #

Overview

Value constructors

See also

Types

Instances

Instances