| Safe Haskell | Safe-Inferred | 
|---|---|
| Language | GHC2021 | 
Database.LSMTree.Internal.Index.OrdinaryAcc
Description
Incremental construction functionality for the general-purpose fence pointer index.
Synopsis
- data IndexOrdinaryAcc s = IndexOrdinaryAcc !(GrowingVector s (Unsliced SerialisedKey)) !(Baler s)
 - new :: Int -> Int -> ST s (IndexOrdinaryAcc s)
 - newWithDefaults :: ST s (IndexOrdinaryAcc s)
 - appendSingle :: (SerialisedKey, SerialisedKey) -> IndexOrdinaryAcc s -> ST s (Maybe Chunk)
 - appendMulti :: (SerialisedKey, Word32) -> IndexOrdinaryAcc s -> ST s [Chunk]
 - unsafeEnd :: IndexOrdinaryAcc s -> ST s (Maybe Chunk, IndexOrdinary)
 
Documentation
data IndexOrdinaryAcc s Source #
A general-purpose fence pointer index under incremental construction.
A value IndexOrdinaryAcc unslicedLastKeys baler denotes a partially
    constructed index that assigns keys to pages according to unslicedLastKeys
    and uses baler for incremental output of the serialised key list.
Constructors
| IndexOrdinaryAcc !(GrowingVector s (Unsliced SerialisedKey)) !(Baler s) | 
Arguments
| :: Int | Initial size of the key buffer  | 
| -> Int | Minimum chunk size in bytes  | 
| -> ST s (IndexOrdinaryAcc s) | Construction of the index  | 
Creates a new, initially empty, index.
newWithDefaults :: ST s (IndexOrdinaryAcc s) Source #
For a specification of this operation, see the documentation of its type-agnostic version.
appendSingle :: (SerialisedKey, SerialisedKey) -> IndexOrdinaryAcc s -> ST s (Maybe Chunk) Source #
For a specification of this operation, see the documentation of its type-agnostic version.
appendMulti :: (SerialisedKey, Word32) -> IndexOrdinaryAcc s -> ST s [Chunk] Source #
For a specification of this operation, see the documentation of its type-agnostic version.
unsafeEnd :: IndexOrdinaryAcc s -> ST s (Maybe Chunk, IndexOrdinary) Source #
For a specification of this operation, see the documentation of its type-agnostic version.