ecluse:ecluse-core
Safe HaskellNone
LanguageGHC2021

Ecluse.Core.Registry.PyPI.Streaming

Description

The fields a Simple-index read passes to its projection, and the fold that selects one release's files. Selected reads retain pending fields only until the first filename excludes the release.

Synopsis

Documentation

data PyPIRead Source #

Select all files or one canonical release while counting every input file.

Instances

Instances details
Show PyPIRead Source # 
Instance details

Defined in Ecluse.Core.Registry.PyPI.Streaming

Eq PyPIRead Source # 
Instance details

Defined in Ecluse.Core.Registry.PyPI.Streaming

data PyPIField Source #

File events carry original positions, including items that yield no retained payload.

Constructors

EnvelopeField Text Value 
EnvelopeItem Text

An item of the named envelope field's array, as it is read and before the field arrives.

FilesShape Bool 
FileField Int (Maybe Value) 
VersionsShape Bool 
InvalidVersionField Int Value 
IgnoredField 

Instances

Instances details
Show PyPIField Source # 
Instance details

Defined in Ecluse.Core.Registry.PyPI.Streaming

Eq PyPIField Source # 
Instance details

Defined in Ecluse.Core.Registry.PyPI.Streaming

fileScalars :: [Text] Source #

The scalar members a file retains.

hashNames :: [Text] Source #

The digest names a file's hashes object can use. Any other name keeps its own key.

data SelectedFileEvent Source #

Scalar payloads wait until the filename survives. The reader still validates their tokens immediately.

data SelectedFile Source #

A file under selection: rejected by its name, or a candidate with its fields so far.

collectSelected :: Text -> FilenameMemo -> SelectedFile -> SelectedFileEvent -> (SelectedFile, FilenameMemo) Source #

Fold one member event into a file under selection, reading its name through the read's memo. The first of each field wins.

finishSelected :: SelectedFile -> Maybe Value Source #

The retained object of a file the requested release names.