ecluse:ecluse-core
Safe HaskellNone
LanguageGHC2021

Ecluse.Core.Registry.Json.Writer

Description

Pack retained values for shared rendering, preserving first members and key order.

Synopsis

Documentation

data Writer st Source #

One read's scratch and member records, shared by every retained value of that read.

Instances

Instances details
TableStrings Writer Source # 
Instance details

Defined in Ecluse.Core.Registry.Json.Writer

Methods

tableValue :: Writer st -> Int -> ST st Value Source #

tableKey :: Writer st -> Int -> ST st Key Source #

Build (Writer st) (ST st (Steps (ST st) s)) Source # 
Instance details

Defined in Ecluse.Core.Registry.Json.Writer

Associated Types

type Built (Writer st) 
Instance details

Defined in Ecluse.Core.Registry.Json.Writer

type Built (Writer st) = ()
type Fields (Writer st) 
Instance details

Defined in Ecluse.Core.Registry.Json.Writer

type Fields (Writer st) = Frame
type Items (Writer st) 
Instance details

Defined in Ecluse.Core.Registry.Json.Writer

type Items (Writer st) = Int

Methods

sharedString :: Writer st -> Entry -> (Built (Writer st) -> ST st (Steps (ST st) s)) -> ST st (Steps (ST st) s) Source #

ownString :: Writer st -> Name -> (Built (Writer st) -> ST st (Steps (ST st) s)) -> ST st (Steps (ST st) s) Source #

integer :: Writer st -> Int -> (Built (Writer st) -> ST st (Steps (ST st) s)) -> ST st (Steps (ST st) s) Source #

whole :: Writer st -> Value -> (Built (Writer st) -> ST st (Steps (ST st) s)) -> ST st (Steps (ST st) s) Source #

emptyContainer :: Writer st -> (Built (Writer st) -> ST st (Steps (ST st) s)) -> ST st (Steps (ST st) s) Source #

openObject :: Writer st -> (Fields (Writer st) -> ST st (Steps (ST st) s)) -> ST st (Steps (ST st) s) Source #

beginMember :: Writer st -> MemberKey -> Fields (Writer st) -> (Bool -> ST st (Steps (ST st) s)) -> ST st (Steps (ST st) s) Source #

addMember :: Writer st -> MemberKey -> Built (Writer st) -> Fields (Writer st) -> (Fields (Writer st) -> ST st (Steps (ST st) s)) -> ST st (Steps (ST st) s) Source #

dropValue :: Writer st -> Built (Writer st) -> ST st (Steps (ST st) s) -> ST st (Steps (ST st) s) Source #

closeObject :: Writer st -> Fields (Writer st) -> (Built (Writer st) -> ST st (Steps (ST st) s)) -> ST st (Steps (ST st) s) Source #

openArray :: Writer st -> (Items (Writer st) -> ST st (Steps (ST st) s)) -> ST st (Steps (ST st) s) Source #

addItem :: Writer st -> Built (Writer st) -> Items (Writer st) -> (Items (Writer st) -> ST st (Steps (ST st) s)) -> ST st (Steps (ST st) s) Source #

closeArray :: Writer st -> Int -> Items (Writer st) -> (Built (Writer st) -> ST st (Steps (ST st) s)) -> ST st (Steps (ST st) s) Source #

type Built (Writer st) Source # 
Instance details

Defined in Ecluse.Core.Registry.Json.Writer

type Built (Writer st) = ()
type Fields (Writer st) Source # 
Instance details

Defined in Ecluse.Core.Registry.Json.Writer

type Fields (Writer st) = Frame
type Items (Writer st) Source # 
Instance details

Defined in Ecluse.Core.Registry.Json.Writer

type Items (Writer st) = Int

packTree :: [Text] -> Value -> Packed Source #

Pack an already bounded tree without another JSON parse or a shared string table.

newWriter :: Maybe (Entry, Entry) -> ST st (Writer st) Source #

Create a read's writer, optionally adding a top-level member. Shared originals are replaced and retained for diagnostics. Owned originals win.

data Frame Source #

An object being written: where its bytes start, and its first member's record.

sealValue :: Writer st -> [Text] -> ST st Packed Source #

Seal the current value for scratch reuse, with its encoded length and a string hole at the member path.

data Pick Source #

Which parts of a packed value a decode needs: all of it, or the named members of an object.

Constructors

Whole 
Only [(Text, Pick)] 

decodePicked :: Writer st -> Pick -> Packed -> ST st Value Source #

Decode picked members through the read's shared strings. Non-object values at member picks decode whole.

decodeWhole :: Writer st -> Packed -> ST st Value Source #

A packed value decoded whole, sharing the read's strings.

replacedMember :: Writer st -> ST st (Maybe Value) Source #

The added member's original value from the last seal, absent after discard or a value without that member.

discard :: Writer st -> ST st () Source #

Forget the value the writer holds, and the member its top-level object replaced.