| Safe Haskell | None |
|---|---|
| Language | GHC2021 |
Ecluse.Core.Registry.PyPI.Document
Contents
Description
Compact Simple indexes keep original file coordinates independently of retained order.
Synopsis
- data SimpleDocument
- simpleDocument :: Object -> [(EntryKey, Value)] -> SimpleDocument
- simpleEnvelope :: SimpleDocument -> Object
- simpleFiles :: SimpleDocument -> [(EntryKey, Value)]
- restrictSimpleFiles :: Set EntryKey -> SimpleDocument -> SimpleDocument
- simpleSourceCompanions :: CompanionRequirement
- simpleEncoding :: SimpleDocument -> Encoding
- data PackedSimple = PackedSimple {
- packedEnvelope :: Object
- packedTable :: DocTable
- packedFiles :: [(EntryKey, Packed)]
- packedSimple :: Object -> DocTable -> [(EntryKey, Packed)] -> PackedSimple
- packedSimpleDocument :: PackedSimple -> Maybe SimpleDocument
- packedSimplePlan :: PackedSimple -> RenderPlan
- packedSimpleResident :: PackedSimple -> Int
- urlHole :: [Text]
Documentation
data SimpleDocument Source #
Supported envelope fields and files associated with their original source positions.
Instances
| Show SimpleDocument Source # | |
Defined in Ecluse.Core.Registry.PyPI.Document Methods showsPrec :: Int -> SimpleDocument -> ShowS # show :: SimpleDocument -> String # showList :: [SimpleDocument] -> ShowS # | |
| Eq SimpleDocument Source # | |
Defined in Ecluse.Core.Registry.PyPI.Document Methods (==) :: SimpleDocument -> SimpleDocument -> Bool # (/=) :: SimpleDocument -> SimpleDocument -> Bool # | |
simpleDocument :: Object -> [(EntryKey, Value)] -> SimpleDocument Source #
Bind compact files to their source coordinates before admission or assembly.
simpleEnvelope :: SimpleDocument -> Object Source #
Supported top-level fields, excluding the file array.
simpleFiles :: SimpleDocument -> [(EntryKey, Value)] Source #
Original keys in source order, including gaps left by discarded files.
restrictSimpleFiles :: Set EntryKey -> SimpleDocument -> SimpleDocument Source #
Keep exact source coordinates, preserving the envelope, order and repeated matching entries.
simpleSourceCompanions :: CompanionRequirement Source #
A retained file needs a companion only where its entry declares core metadata.
simpleEncoding :: SimpleDocument -> Encoding Source #
Preserve envelope key order and file source order, overwriting any envelope files key.
Packed full reads
data PackedSimple Source #
A full read's envelope and packed files, with their original coordinates and shared string table.
Constructors
| PackedSimple | |
Fields
| |
Instances
| Show PackedSimple Source # | |
Defined in Ecluse.Core.Registry.PyPI.Document Methods showsPrec :: Int -> PackedSimple -> ShowS # show :: PackedSimple -> String # showList :: [PackedSimple] -> ShowS # | |
| Eq PackedSimple Source # | |
Defined in Ecluse.Core.Registry.PyPI.Document | |
packedSimple :: Object -> DocTable -> [(EntryKey, Packed)] -> PackedSimple Source #
Bind packed files to source coordinates, excluding any envelope file member.
packedSimpleDocument :: PackedSimple -> Maybe SimpleDocument Source #
Materialise the serving tree for tree-boundary callers, or refuse missing table strings.
packedSimplePlan :: PackedSimple -> RenderPlan Source #
Render a source document in source order without reconstructing file trees or rebasing URLs.
packedSimpleResident :: PackedSimple -> Int Source #
Account for table and file storage, including each file's list cell, pair and coordinate.