Copyright	(c) Dong Han 2020
License	BSD
Maintainer	winterland1989@gmail.com
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Z.Data.YAML

Contents

Decode and encode using YAML
Streaming parser and builder
Errors
Re-Exports

Description

Simple YAML codec using libYAML and JSON's JSON utilities. The design choice to make things as simple as possible since YAML is a complex format, there're some limitations using this approach:

Does not support complex keys.
Does not support multiple doucments in one file.


import           GHC.Generics
import qualified Z.Data.YAML as YAML
import qualified Z.Data.Text as T

data Person = Person
    { name  :: T.Text
    , age   :: Int
    , magic :: Bool
    }
  deriving (Show, Generic)
  deriving anyclass (YAML.JSON)

> YAML.decode @[Person] "- name: Erik Weisz\n  age: 52\n  magic: True\n"
> Right [Person {name = "Erik Weisz", age = 52, magic = True}]

Synopsis

decode :: forall a. (HasCallStack, JSON a) => Bytes -> Either DecodeError a
encode :: (HasCallStack, JSON a) => YAMLFormatOpts -> a -> Text
readYAMLFile :: forall a. (HasCallStack, JSON a) => CBytes -> IO a
writeYAMLFile :: (HasCallStack, JSON a) => YAMLFormatOpts -> CBytes -> a -> IO ()
parseSingleDoucment :: HasCallStack => Source MarkedEvent -> IO Value
parseAllDocuments :: HasCallStack => Source MarkedEvent -> IO [Value]
buildSingleDocument :: HasCallStack => Sink Event -> Value -> IO ()
buildValue :: HasCallStack => Sink Event -> Value -> IO ()
data YAMLError
data YAMLParseError
data ConvertError
type DecodeError = Either YAMLError ConvertError
class JSON a where
- fromValue :: Value -> Converter a
- toValue :: a -> Value
- encodeJSON :: a -> Builder ()
data Value
- = Object !(Vector (Text, Value))
- | Array !(Vector Value)
- | String !Text
- | Number !Scientific
- | Bool !Bool
- | Null

Decode and encode using YAML

decode :: forall a. (HasCallStack, JSON a) => Bytes -> Either DecodeError a Source #

Decode a JSON instance from YAML bytes.

encode :: (HasCallStack, JSON a) => YAMLFormatOpts -> a -> Text Source #

Encode a JSON instance as UTF8 YAML text.

readYAMLFile :: forall a. (HasCallStack, JSON a) => CBytes -> IO a Source #

Decode a JSON instance from a YAML file.

writeYAMLFile :: (HasCallStack, JSON a) => YAMLFormatOpts -> CBytes -> a -> IO () Source #

Encode a JSON instance to YAML file.

Streaming parser and builder

parseSingleDoucment :: HasCallStack => Source MarkedEvent -> IO Value Source #

Parse a single YAML document, throw OtherYAMLError if multiple documents are met.

parseAllDocuments :: HasCallStack => Source MarkedEvent -> IO [Value] Source #

Parse all YAML documents.

buildSingleDocument :: HasCallStack => Sink Event -> Value -> IO () Source #

Write a value as a YAML document stream.

buildValue :: HasCallStack => Sink Event -> Value -> IO () Source #

Write a value as a stream of Events(without document start/end, stream start/end).

Errors

data YAMLError Source #

Constructors

ParseEventException CBytes CBytes Mark	problem, context, mark
ParseAliasEventWithEmptyAnchor Mark Mark
ParseYAMLError YAMLParseError	custom parse error
EmitEventException Event CInt
EmitAliasEventWithEmptyAnchor
OtherYAMLError Text

Instances

Instances details

Eq YAMLError Source #
Instance details Defined in Z.Data.YAML.FFI Methods (==) :: YAMLError -> YAMLError -> Bool # (/=) :: YAMLError -> YAMLError -> Bool #
Show YAMLError Source #
Instance details Defined in Z.Data.YAML.FFI Methods showsPrec :: Int -> YAMLError -> ShowS # show :: YAMLError -> String # showList :: [YAMLError] -> ShowS #
Generic YAMLError Source #
Instance details Defined in Z.Data.YAML.FFI Associated Types type Rep YAMLError :: Type -> Type # Methods from :: YAMLError -> Rep YAMLError x # to :: Rep YAMLError x -> YAMLError #
Print YAMLError Source #
Instance details Defined in Z.Data.YAML.FFI Methods toUTF8BuilderP :: Int -> YAMLError -> Builder () #
Exception YAMLError Source #
Instance details Defined in Z.Data.YAML.FFI Methods toException :: YAMLError -> SomeException # fromException :: SomeException -> Maybe YAMLError # displayException :: YAMLError -> String #
type Rep YAMLError Source #
Instance details Defined in Z.Data.YAML.FFI type Rep YAMLError = D1 ('MetaData "YAMLError" "Z.Data.YAML.FFI" "Z-YAML-0.3.2.0-Iy5ya0bKRJ7BZEQyk88VQP" 'False) ((C1 ('MetaCons "ParseEventException" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CBytes) :: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CBytes) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Mark))) :+: (C1 ('MetaCons "ParseAliasEventWithEmptyAnchor" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Mark) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Mark)) :+: C1 ('MetaCons "ParseYAMLError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 YAMLParseError)))) :+: (C1 ('MetaCons "EmitEventException" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Event) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CInt)) :+: (C1 ('MetaCons "EmitAliasEventWithEmptyAnchor" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OtherYAMLError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))))

data YAMLParseError Source #

Constructors

UnknownAlias MarkedEvent
UnexpectedEvent MarkedEvent
NonStringKey MarkedEvent
NonStringKeyAlias MarkedEvent
UnexpectedEventEnd

Instances

Instances details

Eq YAMLParseError Source #
Instance details Defined in Z.Data.YAML.FFI Methods (==) :: YAMLParseError -> YAMLParseError -> Bool # (/=) :: YAMLParseError -> YAMLParseError -> Bool #
Show YAMLParseError Source #
Instance details Defined in Z.Data.YAML.FFI Methods showsPrec :: Int -> YAMLParseError -> ShowS # show :: YAMLParseError -> String # showList :: [YAMLParseError] -> ShowS #
Generic YAMLParseError Source #
Instance details Defined in Z.Data.YAML.FFI Associated Types type Rep YAMLParseError :: Type -> Type # Methods from :: YAMLParseError -> Rep YAMLParseError x # to :: Rep YAMLParseError x -> YAMLParseError #
Print YAMLParseError Source #
Instance details Defined in Z.Data.YAML.FFI Methods toUTF8BuilderP :: Int -> YAMLParseError -> Builder () #
Exception YAMLParseError Source #
Instance details Defined in Z.Data.YAML.FFI Methods toException :: YAMLParseError -> SomeException # fromException :: SomeException -> Maybe YAMLParseError # displayException :: YAMLParseError -> String #
type Rep YAMLParseError Source #
Instance details Defined in Z.Data.YAML.FFI type Rep YAMLParseError = D1 ('MetaData "YAMLParseError" "Z.Data.YAML.FFI" "Z-YAML-0.3.2.0-Iy5ya0bKRJ7BZEQyk88VQP" 'False) ((C1 ('MetaCons "UnknownAlias" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MarkedEvent)) :+: C1 ('MetaCons "UnexpectedEvent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MarkedEvent))) :+: (C1 ('MetaCons "NonStringKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MarkedEvent)) :+: (C1 ('MetaCons "NonStringKeyAlias" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MarkedEvent)) :+: C1 ('MetaCons "UnexpectedEventEnd" 'PrefixI 'False) (U1 :: Type -> Type))))

data ConvertError #

Error info with (JSON) Path info.

Instances

Instances details

Eq ConvertError
Instance details Defined in Z.Data.JSON.Converter Methods (==) :: ConvertError -> ConvertError -> Bool # (/=) :: ConvertError -> ConvertError -> Bool #
Ord ConvertError
Instance details Defined in Z.Data.JSON.Converter Methods compare :: ConvertError -> ConvertError -> Ordering # (<) :: ConvertError -> ConvertError -> Bool # (<=) :: ConvertError -> ConvertError -> Bool # (>) :: ConvertError -> ConvertError -> Bool # (>=) :: ConvertError -> ConvertError -> Bool # max :: ConvertError -> ConvertError -> ConvertError # min :: ConvertError -> ConvertError -> ConvertError #
Show ConvertError
Instance details Defined in Z.Data.JSON.Converter Methods showsPrec :: Int -> ConvertError -> ShowS # show :: ConvertError -> String # showList :: [ConvertError] -> ShowS #
Generic ConvertError
Instance details Defined in Z.Data.JSON.Converter Associated Types type Rep ConvertError :: Type -> Type # Methods from :: ConvertError -> Rep ConvertError x # to :: Rep ConvertError x -> ConvertError #
Print ConvertError
Instance details Defined in Z.Data.JSON.Converter Methods toUTF8BuilderP :: Int -> ConvertError -> Builder () #
NFData ConvertError
Instance details Defined in Z.Data.JSON.Converter Methods rnf :: ConvertError -> () #
type Rep ConvertError
Instance details Defined in Z.Data.JSON.Converter type Rep ConvertError = D1 ('MetaData "ConvertError" "Z.Data.JSON.Converter" "Z-Data-0.6.0.0-6EPTULxocQtBtAKoZfHPhU" 'False) (C1 ('MetaCons "ConvertError" 'PrefixI 'True) (S1 ('MetaSel ('Just "errPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [PathElement]) :*: S1 ('MetaSel ('Just "errMsg") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

type DecodeError = Either YAMLError ConvertError Source #

Re-Exports

class JSON a where #

Type class for encode & decode JSON.

Minimal complete definition

Nothing

Methods

fromValue :: Value -> Converter a #

toValue :: a -> Value #

encodeJSON :: a -> Builder () #

Instances

Instances details

JSON Bool
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter Bool # toValue :: Bool -> Value # encodeJSON :: Bool -> Builder () #
JSON Char
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter Char # toValue :: Char -> Value # encodeJSON :: Char -> Builder () #
JSON Double
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter Double # toValue :: Double -> Value # encodeJSON :: Double -> Builder () #
JSON Float
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter Float # toValue :: Float -> Value # encodeJSON :: Float -> Builder () #
JSON Int
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter Int # toValue :: Int -> Value # encodeJSON :: Int -> Builder () #
JSON Int8
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter Int8 # toValue :: Int8 -> Value # encodeJSON :: Int8 -> Builder () #
JSON Int16
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter Int16 # toValue :: Int16 -> Value # encodeJSON :: Int16 -> Builder () #
JSON Int32
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter Int32 # toValue :: Int32 -> Value # encodeJSON :: Int32 -> Builder () #
JSON Int64
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter Int64 # toValue :: Int64 -> Value # encodeJSON :: Int64 -> Builder () #
JSON Integer	This instance includes a bounds check to prevent maliciously large inputs to fill up the memory of the target system. You can newtype `Integer` and provide your own instance using `withScientific` if you want to allow larger inputs.
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter Integer # toValue :: Integer -> Value # encodeJSON :: Integer -> Builder () #
JSON Natural	This instance includes a bounds check to prevent maliciously large inputs to fill up the memory of the target system. You can newtype `Natural` and provide your own instance using `withScientific` if you want to allow larger inputs.
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter Natural # toValue :: Natural -> Value # encodeJSON :: Natural -> Builder () #
JSON Ordering
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter Ordering # toValue :: Ordering -> Value # encodeJSON :: Ordering -> Builder () #
JSON Word
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter Word # toValue :: Word -> Value # encodeJSON :: Word -> Builder () #
JSON Word8
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter Word8 # toValue :: Word8 -> Value # encodeJSON :: Word8 -> Builder () #
JSON Word16
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter Word16 # toValue :: Word16 -> Value # encodeJSON :: Word16 -> Builder () #
JSON Word32
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter Word32 # toValue :: Word32 -> Value # encodeJSON :: Word32 -> Builder () #
JSON Word64
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter Word64 # toValue :: Word64 -> Value # encodeJSON :: Word64 -> Builder () #
JSON ()
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter () # toValue :: () -> Value # encodeJSON :: () -> Builder () #
JSON Version	Only round trip `versionBranch` as JSON array.
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter Version # toValue :: Version -> Value # encodeJSON :: Version -> Builder () #
JSON NominalDiffTime	This instance includes a bounds check to prevent maliciously large inputs to fill up the memory of the target system. You can newtype `NominalDiffTime` and provide your own instance using `withScientific` if you want to allow larger inputs.
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter NominalDiffTime # toValue :: NominalDiffTime -> Value # encodeJSON :: NominalDiffTime -> Builder () #
JSON DiffTime	This instance includes a bounds check to prevent maliciously large inputs to fill up the memory of the target system. You can newtype `DiffTime` and provide your own instance using `withScientific` if you want to allow larger inputs.
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter DiffTime # toValue :: DiffTime -> Value # encodeJSON :: DiffTime -> Builder () #
JSON Scientific	Note this instance doesn't reject large input
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter Scientific # toValue :: Scientific -> Value # encodeJSON :: Scientific -> Builder () #
JSON ZonedTime	YYYY-MM-DDTHH:MM:SS.SSSZ
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter ZonedTime # toValue :: ZonedTime -> Value # encodeJSON :: ZonedTime -> Builder () #
JSON LocalTime	YYYY-MM-DDTHH:MM:SS.SSSZ
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter LocalTime # toValue :: LocalTime -> Value # encodeJSON :: LocalTime -> Builder () #
JSON UTCTime	YYYY-MM-DDTHH:MM:SS.SSSZ
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter UTCTime # toValue :: UTCTime -> Value # encodeJSON :: UTCTime -> Builder () #
JSON ByteArray
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter ByteArray # toValue :: ByteArray -> Value # encodeJSON :: ByteArray -> Builder () #
JSON CUIntMax
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CUIntMax # toValue :: CUIntMax -> Value # encodeJSON :: CUIntMax -> Builder () #
JSON CIntMax
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CIntMax # toValue :: CIntMax -> Value # encodeJSON :: CIntMax -> Builder () #
JSON CUIntPtr
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CUIntPtr # toValue :: CUIntPtr -> Value # encodeJSON :: CUIntPtr -> Builder () #
JSON CIntPtr
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CIntPtr # toValue :: CIntPtr -> Value # encodeJSON :: CIntPtr -> Builder () #
JSON CSUSeconds
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CSUSeconds # toValue :: CSUSeconds -> Value # encodeJSON :: CSUSeconds -> Builder () #
JSON CUSeconds
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CUSeconds # toValue :: CUSeconds -> Value # encodeJSON :: CUSeconds -> Builder () #
JSON CTime
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CTime # toValue :: CTime -> Value # encodeJSON :: CTime -> Builder () #
JSON CClock
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CClock # toValue :: CClock -> Value # encodeJSON :: CClock -> Builder () #
JSON CSigAtomic
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CSigAtomic # toValue :: CSigAtomic -> Value # encodeJSON :: CSigAtomic -> Builder () #
JSON CWchar
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CWchar # toValue :: CWchar -> Value # encodeJSON :: CWchar -> Builder () #
JSON CSize
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CSize # toValue :: CSize -> Value # encodeJSON :: CSize -> Builder () #
JSON CPtrdiff
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CPtrdiff # toValue :: CPtrdiff -> Value # encodeJSON :: CPtrdiff -> Builder () #
JSON CDouble
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CDouble # toValue :: CDouble -> Value # encodeJSON :: CDouble -> Builder () #
JSON CFloat
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CFloat # toValue :: CFloat -> Value # encodeJSON :: CFloat -> Builder () #
JSON CBool
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CBool # toValue :: CBool -> Value # encodeJSON :: CBool -> Builder () #
JSON CULLong
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CULLong # toValue :: CULLong -> Value # encodeJSON :: CULLong -> Builder () #
JSON CLLong
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CLLong # toValue :: CLLong -> Value # encodeJSON :: CLLong -> Builder () #
JSON CULong
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CULong # toValue :: CULong -> Value # encodeJSON :: CULong -> Builder () #
JSON CLong
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CLong # toValue :: CLong -> Value # encodeJSON :: CLong -> Builder () #
JSON CUInt
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CUInt # toValue :: CUInt -> Value # encodeJSON :: CUInt -> Builder () #
JSON CInt
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CInt # toValue :: CInt -> Value # encodeJSON :: CInt -> Builder () #
JSON CUShort
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CUShort # toValue :: CUShort -> Value # encodeJSON :: CUShort -> Builder () #
JSON CShort
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CShort # toValue :: CShort -> Value # encodeJSON :: CShort -> Builder () #
JSON CUChar
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CUChar # toValue :: CUChar -> Value # encodeJSON :: CUChar -> Builder () #
JSON CSChar
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CSChar # toValue :: CSChar -> Value # encodeJSON :: CSChar -> Builder () #
JSON CChar
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CChar # toValue :: CChar -> Value # encodeJSON :: CChar -> Builder () #
JSON CBytes	JSON instances check if `CBytes` is properly UTF8 encoded, if it is, decode/encode it as `Text`, otherwise as an object with a base64 field. > encodeText ("hello" :: CBytes) ""hello"" > encodeText ("hello\NUL" :: CBytes) -- `\NUL` is encoded as C0 80, which is illegal UTF8 "{"base64":"aGVsbG/AgA=="}"
Instance details Defined in Z.Data.CBytes Methods fromValue :: Value -> Converter CBytes # toValue :: CBytes -> Value # encodeJSON :: CBytes -> Builder () #
JSON Value
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter Value # toValue :: Value -> Value # encodeJSON :: Value -> Builder () #
JSON FlatIntSet
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter FlatIntSet # toValue :: FlatIntSet -> Value # encodeJSON :: FlatIntSet -> Builder () #
JSON Text
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter Text # toValue :: Text -> Value # encodeJSON :: Text -> Builder () #
JSON Bytes	This is an INCOHERENT instance, encode binary data with base64 encoding.
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter Bytes # toValue :: Bytes -> Value # encodeJSON :: Bytes -> Builder () #
JSON FileEvent
Instance details Defined in Z.IO.FileSystem.Watch Methods fromValue :: Value -> Converter FileEvent # toValue :: FileEvent -> Value # encodeJSON :: FileEvent -> Builder () #
JSON PathStyle
Instance details Defined in Z.IO.FileSystem.FilePath Methods fromValue :: Value -> Converter PathStyle # toValue :: PathStyle -> Value # encodeJSON :: PathStyle -> Builder () #
JSON DirEntType
Instance details Defined in Z.IO.UV.FFI Methods fromValue :: Value -> Converter DirEntType # toValue :: DirEntType -> Value # encodeJSON :: DirEntType -> Builder () #
JSON UVTimeSpec
Instance details Defined in Z.IO.UV.FFI Methods fromValue :: Value -> Converter UVTimeSpec # toValue :: UVTimeSpec -> Value # encodeJSON :: UVTimeSpec -> Builder () #
JSON FStat
Instance details Defined in Z.IO.UV.FFI Methods fromValue :: Value -> Converter FStat # toValue :: FStat -> Value # encodeJSON :: FStat -> Builder () #
JSON AccessResult
Instance details Defined in Z.IO.UV.FFI Methods fromValue :: Value -> Converter AccessResult # toValue :: AccessResult -> Value # encodeJSON :: AccessResult -> Builder () #
JSON UID
Instance details Defined in Z.IO.UV.FFI Methods fromValue :: Value -> Converter UID # toValue :: UID -> Value # encodeJSON :: UID -> Builder () #
JSON GID
Instance details Defined in Z.IO.UV.FFI Methods fromValue :: Value -> Converter GID # toValue :: GID -> Value # encodeJSON :: GID -> Builder () #
JSON ProcessOptions
Instance details Defined in Z.IO.UV.FFI Methods fromValue :: Value -> Converter ProcessOptions # toValue :: ProcessOptions -> Value # encodeJSON :: ProcessOptions -> Builder () #
JSON ProcessStdStream
Instance details Defined in Z.IO.UV.FFI Methods fromValue :: Value -> Converter ProcessStdStream # toValue :: ProcessStdStream -> Value # encodeJSON :: ProcessStdStream -> Builder () #
JSON TimeVal
Instance details Defined in Z.IO.UV.FFI Methods fromValue :: Value -> Converter TimeVal # toValue :: TimeVal -> Value # encodeJSON :: TimeVal -> Builder () #
JSON ResUsage
Instance details Defined in Z.IO.UV.FFI Methods fromValue :: Value -> Converter ResUsage # toValue :: ResUsage -> Value # encodeJSON :: ResUsage -> Builder () #
JSON PID
Instance details Defined in Z.IO.UV.FFI Methods fromValue :: Value -> Converter PID # toValue :: PID -> Value # encodeJSON :: PID -> Builder () #
JSON OSName
Instance details Defined in Z.IO.UV.FFI Methods fromValue :: Value -> Converter OSName # toValue :: OSName -> Value # encodeJSON :: OSName -> Builder () #
JSON PassWD
Instance details Defined in Z.IO.UV.FFI Methods fromValue :: Value -> Converter PassWD # toValue :: PassWD -> Value # encodeJSON :: PassWD -> Builder () #
JSON CPUInfo
Instance details Defined in Z.IO.UV.FFI Methods fromValue :: Value -> Converter CPUInfo # toValue :: CPUInfo -> Value # encodeJSON :: CPUInfo -> Builder () #
JSON TimeVal64
Instance details Defined in Z.IO.UV.FFI Methods fromValue :: Value -> Converter TimeVal64 # toValue :: TimeVal64 -> Value # encodeJSON :: TimeVal64 -> Builder () #
JSON SocketAddr
Instance details Defined in Z.IO.Network.SocketAddr Methods fromValue :: Value -> Converter SocketAddr # toValue :: SocketAddr -> Value # encodeJSON :: SocketAddr -> Builder () #
JSON IPv4
Instance details Defined in Z.IO.Network.SocketAddr Methods fromValue :: Value -> Converter IPv4 # toValue :: IPv4 -> Value # encodeJSON :: IPv4 -> Builder () #
JSON IPv6
Instance details Defined in Z.IO.Network.SocketAddr Methods fromValue :: Value -> Converter IPv6 # toValue :: IPv6 -> Value # encodeJSON :: IPv6 -> Builder () #
JSON PortNumber
Instance details Defined in Z.IO.Network.SocketAddr Methods fromValue :: Value -> Converter PortNumber # toValue :: PortNumber -> Value # encodeJSON :: PortNumber -> Builder () #
JSON SystemTime	`{"seconds": SSS, "nanoseconds": NNN}`.
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter SystemTime # toValue :: SystemTime -> Value # encodeJSON :: SystemTime -> Builder () #
JSON ExitCode
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter ExitCode # toValue :: ExitCode -> Value # encodeJSON :: ExitCode -> Builder () #
JSON IntSet
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter IntSet # toValue :: IntSet -> Value # encodeJSON :: IntSet -> Builder () #
JSON TimeOfDay	HH:MM:SS.SSS
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter TimeOfDay # toValue :: TimeOfDay -> Value # encodeJSON :: TimeOfDay -> Builder () #
JSON CalendarDiffTime
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CalendarDiffTime # toValue :: CalendarDiffTime -> Value # encodeJSON :: CalendarDiffTime -> Builder () #
JSON DayOfWeek
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter DayOfWeek # toValue :: DayOfWeek -> Value # encodeJSON :: DayOfWeek -> Builder () #
JSON Day	YYYY-MM-DD
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter Day # toValue :: Day -> Value # encodeJSON :: Day -> Builder () #
JSON CalendarDiffDays
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter CalendarDiffDays # toValue :: CalendarDiffDays -> Value # encodeJSON :: CalendarDiffDays -> Builder () #
JSON Tag Source #
Instance details Defined in Z.Data.YAML.FFI Methods fromValue :: Value -> Converter Tag # toValue :: Tag -> Value # encodeJSON :: Tag -> Builder () #
JSON Mark Source #
Instance details Defined in Z.Data.YAML.FFI Methods fromValue :: Value -> Converter Mark # toValue :: Mark -> Value # encodeJSON :: Mark -> Builder () #
JSON MarkedEvent Source #
Instance details Defined in Z.Data.YAML.FFI Methods fromValue :: Value -> Converter MarkedEvent # toValue :: MarkedEvent -> Value # encodeJSON :: MarkedEvent -> Builder () #
JSON Event Source #
Instance details Defined in Z.Data.YAML.FFI Methods fromValue :: Value -> Converter Event # toValue :: Event -> Value # encodeJSON :: Event -> Builder () #
JSON [Char]	This is an INCOHERENT instance, to provide JSON text encoding behaviour.
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter [Char] # toValue :: [Char] -> Value # encodeJSON :: [Char] -> Builder () #
JSON a => JSON [a]
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter [a] # toValue :: [a] -> Value # encodeJSON :: [a] -> Builder () #
JSON a => JSON (Maybe a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (Maybe a) # toValue :: Maybe a -> Value # encodeJSON :: Maybe a -> Builder () #
(JSON a, Integral a) => JSON (Ratio a)	This instance includes a bounds check to prevent maliciously large inputs to fill up the memory of the target system. You can newtype Ratio and provide your own instance using `withScientific` if you want to allow larger inputs.
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (Ratio a) # toValue :: Ratio a -> Value # encodeJSON :: Ratio a -> Builder () #
JSON a => JSON (FlatIntMap a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (FlatIntMap a) # toValue :: FlatIntMap a -> Value # encodeJSON :: FlatIntMap a -> Builder () #
(Ord a, JSON a) => JSON (FlatSet a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (FlatSet a) # toValue :: FlatSet a -> Value # encodeJSON :: FlatSet a -> Builder () #
JSON a => JSON (Vector a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (Vector a) # toValue :: Vector a -> Value # encodeJSON :: Vector a -> Builder () #
(Prim a, JSON a) => JSON (PrimVector a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (PrimVector a) # toValue :: PrimVector a -> Value # encodeJSON :: PrimVector a -> Builder () #
JSON a => JSON (Array a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (Array a) # toValue :: Array a -> Value # encodeJSON :: Array a -> Builder () #
JSON a => JSON (SmallArray a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (SmallArray a) # toValue :: SmallArray a -> Value # encodeJSON :: SmallArray a -> Builder () #
(Prim a, JSON a) => JSON (PrimArray a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (PrimArray a) # toValue :: PrimArray a -> Value # encodeJSON :: PrimArray a -> Builder () #
JSON a => JSON (Min a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (Min a) # toValue :: Min a -> Value # encodeJSON :: Min a -> Builder () #
JSON a => JSON (Max a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (Max a) # toValue :: Max a -> Value # encodeJSON :: Max a -> Builder () #
JSON a => JSON (First a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (First a) # toValue :: First a -> Value # encodeJSON :: First a -> Builder () #
JSON a => JSON (Last a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (Last a) # toValue :: Last a -> Value # encodeJSON :: Last a -> Builder () #
JSON a => JSON (WrappedMonoid a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (WrappedMonoid a) # toValue :: WrappedMonoid a -> Value # encodeJSON :: WrappedMonoid a -> Builder () #
JSON a => JSON (Identity a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (Identity a) # toValue :: Identity a -> Value # encodeJSON :: Identity a -> Builder () #
JSON a => JSON (First a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (First a) # toValue :: First a -> Value # encodeJSON :: First a -> Builder () #
JSON a => JSON (Last a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (Last a) # toValue :: Last a -> Value # encodeJSON :: Last a -> Builder () #
JSON a => JSON (Dual a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (Dual a) # toValue :: Dual a -> Value # encodeJSON :: Dual a -> Builder () #
JSON a => JSON (NonEmpty a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (NonEmpty a) # toValue :: NonEmpty a -> Value # encodeJSON :: NonEmpty a -> Builder () #
JSON a => JSON (IntMap a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (IntMap a) # toValue :: IntMap a -> Value # encodeJSON :: IntMap a -> Builder () #
JSON a => JSON (Tree a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (Tree a) # toValue :: Tree a -> Value # encodeJSON :: Tree a -> Builder () #
JSON a => JSON (Seq a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (Seq a) # toValue :: Seq a -> Value # encodeJSON :: Seq a -> Builder () #
(Ord a, JSON a) => JSON (Set a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (Set a) # toValue :: Set a -> Value # encodeJSON :: Set a -> Builder () #
(Eq a, Hashable a, JSON a) => JSON (HashSet a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (HashSet a) # toValue :: HashSet a -> Value # encodeJSON :: HashSet a -> Builder () #
(JSON a, JSON b) => JSON (Either a b)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (Either a b) # toValue :: Either a b -> Value # encodeJSON :: Either a b -> Builder () #
(JSON a, JSON b) => JSON (a, b)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (a, b) # toValue :: (a, b) -> Value # encodeJSON :: (a, b) -> Builder () #
JSON a => JSON (FlatMap Text a)	default instance prefer later key
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (FlatMap Text a) # toValue :: FlatMap Text a -> Value # encodeJSON :: FlatMap Text a -> Builder () #
(PrimUnlifted a, JSON a) => JSON (UnliftedArray a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (UnliftedArray a) # toValue :: UnliftedArray a -> Value # encodeJSON :: UnliftedArray a -> Builder () #
HasResolution a => JSON (Fixed a)	This instance includes a bounds check to prevent maliciously large inputs to fill up the memory of the target system. You can newtype Fixed and provide your own instance using `withScientific` if you want to allow larger inputs.
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (Fixed a) # toValue :: Fixed a -> Value # encodeJSON :: Fixed a -> Builder () #
JSON (Proxy a)	Use `Null` as `Proxy a`
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (Proxy a) # toValue :: Proxy a -> Value # encodeJSON :: Proxy a -> Builder () #
JSON a => JSON (Map Text a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (Map Text a) # toValue :: Map Text a -> Value # encodeJSON :: Map Text a -> Builder () #
JSON a => JSON (HashMap Text a)	default instance prefer later key
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (HashMap Text a) # toValue :: HashMap Text a -> Value # encodeJSON :: HashMap Text a -> Builder () #
(JSON a, JSON b, JSON c) => JSON (a, b, c)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (a, b, c) # toValue :: (a, b, c) -> Value # encodeJSON :: (a, b, c) -> Builder () #
JSON a => JSON (Const a b)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (Const a b) # toValue :: Const a b -> Value # encodeJSON :: Const a b -> Builder () #
JSON b => JSON (Tagged a b)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (Tagged a b) # toValue :: Tagged a b -> Value # encodeJSON :: Tagged a b -> Builder () #
(JSON a, JSON b, JSON c, JSON d) => JSON (a, b, c, d)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (a, b, c, d) # toValue :: (a, b, c, d) -> Value # encodeJSON :: (a, b, c, d) -> Builder () #
(JSON (f a), JSON (g a)) => JSON (Product f g a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (Product f g a) # toValue :: Product f g a -> Value # encodeJSON :: Product f g a -> Builder () #
(JSON (f a), JSON (g a), JSON a) => JSON (Sum f g a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (Sum f g a) # toValue :: Sum f g a -> Value # encodeJSON :: Sum f g a -> Builder () #
(JSON a, JSON b, JSON c, JSON d, JSON e) => JSON (a, b, c, d, e)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (a, b, c, d, e) # toValue :: (a, b, c, d, e) -> Value # encodeJSON :: (a, b, c, d, e) -> Builder () #
JSON (f (g a)) => JSON (Compose f g a)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (Compose f g a) # toValue :: Compose f g a -> Value # encodeJSON :: Compose f g a -> Builder () #
(JSON a, JSON b, JSON c, JSON d, JSON e, JSON f) => JSON (a, b, c, d, e, f)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (a, b, c, d, e, f) # toValue :: (a, b, c, d, e, f) -> Value # encodeJSON :: (a, b, c, d, e, f) -> Builder () #
(JSON a, JSON b, JSON c, JSON d, JSON e, JSON f, JSON g) => JSON (a, b, c, d, e, f, g)
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter (a, b, c, d, e, f, g) # toValue :: (a, b, c, d, e, f, g) -> Value # encodeJSON :: (a, b, c, d, e, f, g) -> Builder () #

data Value #

A JSON value represented as a Haskell value.

The Object's payload is a key-value vector instead of a map, which parsed directly from JSON document. This design choice has following advantages:

Allow different strategies handling duplicated keys.
Allow different Map type to do further parsing, e.g. FlatMap
Roundtrip without touching the original key-value order.
Save time if constructing map is not neccessary, e.g. using a linear scan to find a key if only that key is needed.

Constructors

Object !(Vector (Text, Value))
Array !(Vector Value)
String !Text
Number !Scientific
Bool !Bool
Null

Instances

Instances details

Eq Value
Instance details Defined in Z.Data.JSON.Value Methods (==) :: Value -> Value -> Bool # (/=) :: Value -> Value -> Bool #
Ord Value
Instance details Defined in Z.Data.JSON.Value Methods compare :: Value -> Value -> Ordering # (<) :: Value -> Value -> Bool # (<=) :: Value -> Value -> Bool # (>) :: Value -> Value -> Bool # (>=) :: Value -> Value -> Bool # max :: Value -> Value -> Value # min :: Value -> Value -> Value #
Show Value
Instance details Defined in Z.Data.JSON.Value Methods showsPrec :: Int -> Value -> ShowS # show :: Value -> String # showList :: [Value] -> ShowS #
Generic Value
Instance details Defined in Z.Data.JSON.Value Associated Types type Rep Value :: Type -> Type # Methods from :: Value -> Rep Value x # to :: Rep Value x -> Value #
Arbitrary Value
Instance details Defined in Z.Data.JSON.Value Methods arbitrary :: Gen Value # shrink :: Value -> [Value] #
JSON Value
Instance details Defined in Z.Data.JSON.Base Methods fromValue :: Value -> Converter Value # toValue :: Value -> Value # encodeJSON :: Value -> Builder () #
Print Value
Instance details Defined in Z.Data.JSON.Value Methods toUTF8BuilderP :: Int -> Value -> Builder () #
NFData Value
Instance details Defined in Z.Data.JSON.Value Methods rnf :: Value -> () #
type Rep Value
Instance details Defined in Z.Data.JSON.Value type Rep Value = D1 ('MetaData "Value" "Z.Data.JSON.Value" "Z-Data-0.6.0.0-6EPTULxocQtBtAKoZfHPhU" 'False) ((C1 ('MetaCons "Object" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 (Vector (Text, Value)))) :+: (C1 ('MetaCons "Array" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 (Vector Value))) :+: C1 ('MetaCons "String" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Text)))) :+: (C1 ('MetaCons "Number" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Scientific)) :+: (C1 ('MetaCons "Bool" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)) :+: C1 ('MetaCons "Null" 'PrefixI 'False) (U1 :: Type -> Type))))