ecluse:ecluse-core
Safe HaskellNone
LanguageGHC2021

Ecluse.Core.Registry.JsonStream

Description

Incremental registry extraction within a decompressed body ceiling. The maintained lexer copies decoded strings and keys into owned arrays, including chunk-spanning tokens. Opaque cursors can retain input slices until the walk advances.

Synopsis

Bounded reads

data StreamResult a Source #

Extracted data and the size of the complete decompressed source, including ignored fields.

Instances

Instances details
Show a => Show (StreamResult a) Source # 
Instance details

Defined in Ecluse.Core.Registry.JsonStream

Eq a => Eq (StreamResult a) Source # 
Instance details

Defined in Ecluse.Core.Registry.JsonStream

data Steps (m :: Type -> Type) s Source #

A suspended, failed, refused or finished read. Writing reads resume in their own effect.

Constructors

NeedData (ByteString -> m (Steps m s)) 
Failed Text 
Refused LimitError 
Finished s 

Instances

Instances details
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 #

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

Defined in Ecluse.Core.Registry.Npm.VersionWriter

Associated Types

type Built (VersionWriter st) 
Instance details

Defined in Ecluse.Core.Registry.Npm.VersionWriter

type Fields (VersionWriter st) 
Instance details

Defined in Ecluse.Core.Registry.Npm.VersionWriter

type Items (VersionWriter st) 
Instance details

Defined in Ecluse.Core.Registry.Npm.VersionWriter

type Items (VersionWriter st) = Int

Methods

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Defined in Ecluse.Core.Registry.PyPI.FileWriter

Associated Types

type Built (FileWriter st) 
Instance details

Defined in Ecluse.Core.Registry.PyPI.FileWriter

type Fields (FileWriter st) 
Instance details

Defined in Ecluse.Core.Registry.PyPI.FileWriter

type Fields (FileWriter st)
type Items (FileWriter st) 
Instance details

Defined in Ecluse.Core.Registry.PyPI.FileWriter

type Items (FileWriter st) = Int

Methods

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

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

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

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

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

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

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

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

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

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

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

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

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

Walk (Steps Identity s) Source # 
Instance details

Defined in Ecluse.Core.Registry.Json.Walk

Associated Types

type Result (Steps Identity s) 
Instance details

Defined in Ecluse.Core.Registry.Json.Walk

type Result (Steps Identity s) = s
Walk (ST st (Steps (ST st) s)) Source # 
Instance details

Defined in Ecluse.Core.Registry.Json.Walk

Associated Types

type Result (ST st (Steps (ST st) s)) 
Instance details

Defined in Ecluse.Core.Registry.Json.Walk

type Result (ST st (Steps (ST st) s)) = s

Methods

needData :: (ByteString -> ST st (Steps (ST st) s)) -> ST st (Steps (ST st) s) Source #

failWith :: Text -> ST st (Steps (ST st) s) Source #

refuse :: LimitError -> ST st (Steps (ST st) s) Source #

finish :: Result (ST st (Steps (ST st) s)) -> ST st (Steps (ST st) s) Source #

type Result (Steps Identity s) Source # 
Instance details

Defined in Ecluse.Core.Registry.Json.Walk

type Result (Steps Identity s) = s
type Result (ST st (Steps (ST st) s)) Source # 
Instance details

Defined in Ecluse.Core.Registry.Json.Walk

type Result (ST st (Steps (ST st) s)) = s

type Step = Steps Identity Source #

A read with no effect of its own.

readSteps :: Monad n => (forall a. m a -> n a) -> BodyLimit -> Steps m s -> n ByteString -> n (Either LimitError (StreamResult s)) Source #

Enforce the body ceiling with pieces of at most 32 KiB, then drain until an empty chunk ends the body.

readStepsWithEnd :: Monad n => (forall a. m a -> n a) -> (Steps m s -> n (Steps m s)) -> BodyLimit -> Steps m s -> n ByteString -> n (Either LimitError (StreamResult s)) Source #

Finalise a framed read at EOF without feeding an invented source byte to its consumer.

readJsonStream :: Monad m => BodyLimit -> Parser a -> (s -> a -> Either LimitError s) -> s -> m ByteString -> m (Either LimitError (StreamResult s)) Source #

Fold each value the parser yields through the step, as readSteps feeds it.

maxChunkBytes :: Int Source #

The largest piece of a chunk a read feeds its consumer at once.

Retained values

retainedValue :: Int -> Parser Value Source #

Decode a retained field within a structural budget. Unknown fields never call this parser.

withinRetainedDepth :: Int -> Parser a -> Parser a Source #

Charge the parsed value's own level, including empty containers. Children need one less level.

nestingLimit :: Text Source #

The parse error that marks a retained value past its structural budget.

isNestingLimit :: ParseError -> Bool Source #

Distinguish a retained-depth refusal from malformed JSON.

isJsonSpace :: Word8 -> Bool Source #

JSON permits only space, tab, CR and LF as whitespace.

data Members Source #

Object member selection. Named members share each stored key across retained objects.

everyMember :: Parser Value -> Members Source #

Retain every member with one parser, each under its own key.

retainedScalar :: Parser Value Source #

Read a scalar without materialising an object or array when the field has the wrong shape.

retainedObjectWith :: Parser Value -> Members -> Parser Value Source #

Select object events before folding. The fallback handles scalars and other container shapes.

retainedArrayWith :: Parser Value -> Parser Value -> Parser Value Source #

Select array events before folding. A container fallback must yield only its completed value.