HaskellWorks.Data.Json.PartialValue

Documentation

data JsonPartialValue

Partial JSON type.

This data type has an additional JsonPartialError data constructor to indicate parsing errors. This allows parsing to be more lazy because parsing errors may now be expressed anywhere in the parsed document so the parser no longer needs to make a verdict about whether there are any parsing errors in the entire document.

See jsonPartialJsonValueAt on how to parse JSON text into this datatype.

Although this data type allows for lazier parsing it doesn't allow for sub-trees to be garbage collected if a reference to an ancestor node is held. To avoid holding onto sub-trees that are no longer needed without having to drop references to ancestors use LightJson instead.

Constructors

JsonPartialString Text

JsonPartialNumber Double

JsonPartialObject [(Text, JsonPartialValue)]

JsonPartialArray [JsonPartialValue]

JsonPartialBool Bool

JsonPartialNull

JsonPartialError Text

Instances

Pretty JsonPartialValue

Defined in HaskellWorks.Data.Json.PartialValue

Methods

pretty :: JsonPartialValue -> Doc

prettyList :: [JsonPartialValue] -> Doc

Show JsonPartialValue

Defined in HaskellWorks.Data.Json.PartialValue

Methods

showsPrec :: Int -> JsonPartialValue -> ShowS

show :: JsonPartialValue -> String

showList :: [JsonPartialValue] -> ShowS

Eq JsonPartialValue

Defined in HaskellWorks.Data.Json.PartialValue

Methods

(==) :: JsonPartialValue -> JsonPartialValue -> Bool

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

Ord JsonPartialValue

Defined in HaskellWorks.Data.Json.PartialValue

Methods

compare :: JsonPartialValue -> JsonPartialValue -> Ordering

(<) :: JsonPartialValue -> JsonPartialValue -> Bool

(<=) :: JsonPartialValue -> JsonPartialValue -> Bool

(>) :: JsonPartialValue -> JsonPartialValue -> Bool

(>=) :: JsonPartialValue -> JsonPartialValue -> Bool

max :: JsonPartialValue -> JsonPartialValue -> JsonPartialValue

min :: JsonPartialValue -> JsonPartialValue -> JsonPartialValue

Pretty (MQuery JsonPartialValue)

Defined in HaskellWorks.Data.Json.PartialValue

Methods

pretty :: MQuery JsonPartialValue -> Doc

prettyList :: [MQuery JsonPartialValue] -> Doc

Pretty (MQuery (Entry Text JsonPartialValue))

Defined in HaskellWorks.Data.Json.PartialValue

Methods

pretty :: MQuery (Entry Text JsonPartialValue) -> Doc

prettyList :: [MQuery (Entry Text JsonPartialValue)] -> Doc

Pretty (Micro JsonPartialValue)

Defined in HaskellWorks.Data.Json.PartialValue

Methods

pretty :: Micro JsonPartialValue -> Doc

prettyList :: [Micro JsonPartialValue] -> Doc

Pretty (Micro (Text, JsonPartialValue))

Defined in HaskellWorks.Data.Json.PartialValue

Methods

pretty :: Micro (Text, JsonPartialValue) -> Doc

prettyList :: [Micro (Text, JsonPartialValue)] -> Doc

Pretty (Micro (String, JsonPartialValue))

Defined in HaskellWorks.Data.Json.PartialValue

Methods

pretty :: Micro (String, JsonPartialValue) -> Doc

prettyList :: [Micro (String, JsonPartialValue)] -> Doc

Pretty (Mini JsonPartialValue)

Defined in HaskellWorks.Data.Json.PartialValue

Methods

pretty :: Mini JsonPartialValue -> Doc

prettyList :: [Mini JsonPartialValue] -> Doc

Pretty (Mini (Text, JsonPartialValue))

Defined in HaskellWorks.Data.Json.PartialValue

Methods

pretty :: Mini (Text, JsonPartialValue) -> Doc

prettyList :: [Mini (Text, JsonPartialValue)] -> Doc

class JsonPartialValueAt a where

Methods

jsonPartialJsonValueAt :: a -> JsonPartialValue

Get a JSON partial value from another type

This function can always "succeed" because the data type it returns allows for the document value to contain an arbitrary number of errors. This means errors can be reported in document nodes as parsing occurs lazily.

There are garbage collection implementations you may want to consider. If you would like to be able to hold onto ancestor nodes and still be able to garbage collect visited sub-trees, then consider using lightJsonAt instead.

Instances

JsonPartialValueAt JsonPartialIndex

Defined in HaskellWorks.Data.Json.PartialValue

Methods

jsonPartialJsonValueAt :: JsonPartialIndex -> JsonPartialValue

(BalancedParens w, Rank0 w, Rank1 w, Select1 v, TestBit w) => JsonPartialValueAt (GenericCursor ByteString v w)

Defined in HaskellWorks.Data.Json.PartialValue

Methods

jsonPartialJsonValueAt :: GenericCursor ByteString v w -> JsonPartialValue

asInteger :: JsonPartialValue -> MQuery Integer

asString :: JsonPartialValue -> MQuery String

asText :: JsonPartialValue -> MQuery Text

castAsInteger :: JsonPartialValue -> MQuery Integer

entry :: JsonPartialValue -> MQuery (Entry Text JsonPartialValue)

hasKey :: Text -> JsonPartialValue -> Bool

hasKV :: Text -> JsonPartialValue -> JsonPartialValue -> MQuery JsonPartialValue

item :: JsonPartialValue -> MQuery JsonPartialValue

jsonKeys :: JsonPartialValue -> [Text]

jsonSize :: JsonPartialValue -> MQuery JsonPartialValue

named :: Text -> Entry Text JsonPartialValue -> MQuery JsonPartialValue