Merge pull request #657 from IntersectMBO/wenkokke/fence-pointer-index-type

fix: rename FencePointerIndex to FencePointerIndexType

Author: jorisdral

src-extras/Database/LSMTree/Extras/NoThunks.hs

@@ -632,8 +632,8 @@ deriving anyclass instance NoThunks WriteBufferAlloc
 deriving stock instance Generic BloomFilterAlloc
 deriving anyclass instance NoThunks BloomFilterAlloc
 
-deriving stock instance Generic FencePointerIndex
-deriving anyclass instance NoThunks FencePointerIndex
+deriving stock instance Generic FencePointerIndexType
+deriving anyclass instance NoThunks FencePointerIndexType
 
 deriving stock instance Generic DiskCachePolicy
 deriving anyclass instance NoThunks DiskCachePolicy

src/Database/LSMTree.hs

@@ -48,7 +48,7 @@ module Database.LSMTree (
   , Common.NumEntries (..)
   , Common.BloomFilterAlloc (..)
   , Common.defaultBloomFilterAlloc
-  , Common.FencePointerIndex (..)
+  , Common.FencePointerIndexType (..)
   , Common.DiskCachePolicy (..)
   , Common.MergeSchedule (..)
   , Common.defaultMergeSchedule

src/Database/LSMTree/Common.hs

@@ -53,7 +53,7 @@ module Database.LSMTree.Common (
   , Internal.NumEntries (..)
   , Internal.BloomFilterAlloc (..)
   , Internal.defaultBloomFilterAlloc
-  , Internal.FencePointerIndex (..)
+  , Internal.FencePointerIndexType (..)
   , Internal.DiskCachePolicy (..)
   , Internal.MergeSchedule (..)
   , Internal.defaultMergeSchedule

src/Database/LSMTree/Internal/Config.hs

@@ -24,7 +24,7 @@ module Database.LSMTree.Internal.Config (
   , defaultBloomFilterAlloc
   , bloomFilterAllocForLevel
     -- * Fence pointer index
-  , FencePointerIndex (..)
+  , FencePointerIndexType (..)
   , indexTypeForRun
     -- * Disk cache policy
   , DiskCachePolicy (..)
@@ -71,7 +71,7 @@ data TableConfig = TableConfig {
     -- applications.
   , confWriteBufferAlloc  :: !WriteBufferAlloc
   , confBloomFilterAlloc  :: !BloomFilterAlloc
-  , confFencePointerIndex :: !FencePointerIndex
+  , confFencePointerIndex :: !FencePointerIndexType
     -- | The policy for caching key\/value data from disk in memory.
   , confDiskCachePolicy   :: !DiskCachePolicy
   , confMergeSchedule     :: !MergeSchedule
@@ -240,7 +240,7 @@ bloomFilterAllocForLevel conf _levelNo =
 -------------------------------------------------------------------------------}
 
 -- | Configure the type of fence pointer index.
-data FencePointerIndex =
+data FencePointerIndexType =
     -- | Use a compact fence pointer index.
     --
     -- Compact indexes are designed to work with keys that are large (for
@@ -263,11 +263,11 @@ data FencePointerIndex =
   | OrdinaryIndex
   deriving stock (Eq, Show)
 
-instance NFData FencePointerIndex where
+instance NFData FencePointerIndexType where
   rnf CompactIndex  = ()
   rnf OrdinaryIndex = ()
 
-indexTypeForRun :: FencePointerIndex -> IndexType
+indexTypeForRun :: FencePointerIndexType -> IndexType
 indexTypeForRun CompactIndex  = Index.Compact
 indexTypeForRun OrdinaryIndex = Index.Ordinary
 

src/Database/LSMTree/Internal/Snapshot/Codec.hs

@@ -447,19 +447,19 @@ instance DecodeVersioned BloomFilterAlloc where
         (2, 1) -> AllocRequestFPR <$> decodeDouble
         _ -> fail ("[BloomFilterAlloc] Unexpected combination of list length and tag: " <> show (n, tag))
 
--- FencePointerIndex
+-- FencePointerIndexType
 
-instance Encode FencePointerIndex where
+instance Encode FencePointerIndexType where
   encode CompactIndex  = encodeWord 0
   encode OrdinaryIndex = encodeWord 1
 
-instance DecodeVersioned FencePointerIndex where
+instance DecodeVersioned FencePointerIndexType where
    decodeVersioned V0 = do
       tag <- decodeWord
       case tag of
         0 -> pure CompactIndex
         1 -> pure OrdinaryIndex
-        _ -> fail ("[FencePointerIndex] Unexpected tag: " <> show tag)
+        _ -> fail ("[FencePointerIndexType] Unexpected tag: " <> show tag)
 
 -- DiskCachePolicy
 

src/Database/LSMTree/Monoidal.hs

@@ -63,7 +63,7 @@ module Database.LSMTree.Monoidal (
   , Common.NumEntries (..)
   , Common.BloomFilterAlloc (..)
   , Common.defaultBloomFilterAlloc
-  , Common.FencePointerIndex (..)
+  , Common.FencePointerIndexType (..)
   , Common.DiskCachePolicy (..)
   , Common.MergeSchedule (..)
   , Common.defaultMergeSchedule

src/Database/LSMTree/Normal.hs

@@ -62,7 +62,7 @@ module Database.LSMTree.Normal (
   , Common.NumEntries (..)
   , Common.BloomFilterAlloc (..)
   , Common.defaultBloomFilterAlloc
-  , Common.FencePointerIndex (..)
+  , Common.FencePointerIndexType (..)
   , Common.DiskCachePolicy (..)
   , Common.MergeSchedule (..)
   , Common.defaultMergeSchedule

test/Test/Database/LSMTree/Internal/Snapshot/Codec.hs

@@ -161,7 +161,7 @@ testAll test = [
     , test (Proxy @WriteBufferAlloc)
     , test (Proxy @NumEntries)
     , test (Proxy @BloomFilterAlloc)
-    , test (Proxy @FencePointerIndex)
+    , test (Proxy @FencePointerIndexType)
     , test (Proxy @DiskCachePolicy)
     , test (Proxy @MergeSchedule)
       -- SnapLevels
@@ -262,7 +262,7 @@ instance Arbitrary BloomFilterAlloc where
   shrink (AllocFixed x)      = AllocFixed <$> shrink x
   shrink (AllocRequestFPR x) = AllocRequestFPR <$> shrink x
 
-instance Arbitrary FencePointerIndex where
+instance Arbitrary FencePointerIndexType where
   arbitrary = elements [CompactIndex, OrdinaryIndex]
   shrink _ = []
 

test/Test/Database/LSMTree/Internal/Snapshot/Codec/Golden.hs

@@ -13,7 +13,7 @@ import qualified Data.Vector as V
 import           Database.LSMTree.Common (BloomFilterAlloc (..),
                      DiskCachePolicy (..), NumEntries (..), TableConfig (..),
                      WriteBufferAlloc (..), defaultTableConfig)
-import           Database.LSMTree.Internal.Config (FencePointerIndex (..),
+import           Database.LSMTree.Internal.Config (FencePointerIndexType (..),
                      MergePolicy (..), MergeSchedule (..), SizeRatio (..))
 import           Database.LSMTree.Internal.MergeSchedule
                      (MergePolicyForLevel (..), NominalCredits (..),

test/Test/Database/LSMTree/StateMachine.hs

@@ -280,9 +280,9 @@ instance Arbitrary R.WriteBufferAlloc where
       | QC.Positive x' <- QC.shrink (QC.Positive x)
       ]
 
-deriving stock instance Enum R.FencePointerIndex
-deriving stock instance Bounded R.FencePointerIndex
-instance Arbitrary R.FencePointerIndex where
+deriving stock instance Enum R.FencePointerIndexType
+deriving stock instance Bounded R.FencePointerIndexType
+instance Arbitrary R.FencePointerIndexType where
   arbitrary = QC.arbitraryBoundedEnum
   shrink R.OrdinaryIndex = []
   shrink R.CompactIndex  = [R.OrdinaryIndex]