Safe Haskell	Safe-Inferred
Language	GHC2021

Database.LSMTree.Internal.Serialise.Class

Contents

Errors

Description

Public API for serialisation of keys, blobs and values

Synopsis

class SerialiseKey k where
- serialiseKey :: k -> RawBytes
- deserialiseKey :: RawBytes -> k
serialiseKeyIdentity :: (Eq k, SerialiseKey k) => k -> Bool
serialiseKeyIdentityUpToSlicing :: (Eq k, SerialiseKey k) => RawBytes -> k -> RawBytes -> Bool
serialiseKeyPreservesOrdering :: (Ord k, SerialiseKey k) => k -> k -> Bool
serialiseKeyMinimalSize :: SerialiseKey k => k -> Bool
class SerialiseValue v where
- serialiseValue :: v -> RawBytes
- deserialiseValue :: RawBytes -> v
serialiseValueIdentity :: (Eq v, SerialiseValue v) => v -> Bool
serialiseValueIdentityUpToSlicing :: (Eq v, SerialiseValue v) => RawBytes -> v -> RawBytes -> Bool
newtype RawBytes = RawBytes (Vector Word8)
packSlice :: RawBytes -> RawBytes -> RawBytes -> RawBytes
requireBytesExactly :: String -> Int -> Int -> a -> a

Documentation

class SerialiseKey k where Source #

Serialisation of keys.

Instances should satisfy the following:

Identity: deserialiseKey (serialiseKey x) == x
Identity up to slicing: deserialiseKey (packSlice prefix (serialiseKey x) suffix) == x

Instances may satisfy the following:

Ordering-preserving: x `compare` y == serialiseKey x `compare` serialiseKey y

Raw bytes are lexicographically ordered, so in particular this means that values should be serialised into big-endian formats. This constraint mainly exists for range queries, where the range is specified in terms of unserialised values, but the internal implementation works on the serialised representation.

Methods

serialiseKey :: k -> RawBytes Source #

deserialiseKey :: RawBytes -> k Source #

Instances

Instances details

SerialiseKey Word64 Source #
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseKey :: Word64 -> RawBytes Source # deserialiseKey :: RawBytes -> Word64 Source #
SerialiseKey ByteString Source #	Placeholder instance, not optimised
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseKey :: ByteString -> RawBytes Source # deserialiseKey :: RawBytes -> ByteString Source #
SerialiseKey ByteString Source #	Placeholder instance, not optimised
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseKey :: ByteString -> RawBytes Source # deserialiseKey :: RawBytes -> ByteString Source #
SerialiseKey ShortByteString Source #
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseKey :: ShortByteString -> RawBytes Source # deserialiseKey :: RawBytes -> ShortByteString Source #

serialiseKeyIdentity :: (Eq k, SerialiseKey k) => k -> Bool Source #

Test the Identity law for the SerialiseKey class

serialiseKeyIdentityUpToSlicing :: (Eq k, SerialiseKey k) => RawBytes -> k -> RawBytes -> Bool Source #

Test the Identity up to slicing law for the SerialiseKey class

serialiseKeyPreservesOrdering :: (Ord k, SerialiseKey k) => k -> k -> Bool Source #

Test the Ordering-preserving law for the SerialiseKey class

serialiseKeyMinimalSize :: SerialiseKey k => k -> Bool Source #

Test the Minimal size law for the SerialiseKey class.

class SerialiseValue v where Source #

Serialisation of values and blobs.

Instances should satisfy the following:

Identity: deserialiseValue (serialiseValue x) == x
Identity up to slicing: deserialiseValue (packSlice prefix (serialiseValue x) suffix) == x

Methods

serialiseValue :: v -> RawBytes Source #

deserialiseValue :: RawBytes -> v Source #

Instances

Instances details

SerialiseValue ByteArray Source #	The `Ord` instance of `ByteArray` is not lexicographic, so there cannot be an order-preserving instance of `SerialiseKey`. Use `ShortByteString` instead.
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseValue :: ByteArray -> RawBytes Source # deserialiseValue :: RawBytes -> ByteArray Source #
SerialiseValue Void Source #	The `deserialiseValue` of this instance throws. (as does e.g. `Word64` instance on invalid input.) This instance is useful for tables without blobs.
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseValue :: Void -> RawBytes Source # deserialiseValue :: RawBytes -> Void Source #
SerialiseValue Word64 Source #
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseValue :: Word64 -> RawBytes Source # deserialiseValue :: RawBytes -> Word64 Source #
SerialiseValue ByteString Source #	Placeholder instance, not optimised
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseValue :: ByteString -> RawBytes Source # deserialiseValue :: RawBytes -> ByteString Source #
SerialiseValue ByteString Source #	Placeholder instance, not optimised
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseValue :: ByteString -> RawBytes Source # deserialiseValue :: RawBytes -> ByteString Source #
SerialiseValue ShortByteString Source #
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseValue :: ShortByteString -> RawBytes Source # deserialiseValue :: RawBytes -> ShortByteString Source #
SerialiseValue a => SerialiseValue (Sum a) Source #	An instance for `Sum` which is transparent to the serialisation of `a`. Note: If you want to serialize `Sum a` differently than `a`, then you should create another `newtype` over `Sum` and define your alternative serialization.
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseValue :: Sum a -> RawBytes Source # deserialiseValue :: RawBytes -> Sum a Source #
SerialiseValue v => SerialiseValue (ResolveAsFirst v) Source #
Instance details Defined in Database.LSMTree Methods serialiseValue :: ResolveAsFirst v -> RawBytes Source # deserialiseValue :: RawBytes -> ResolveAsFirst v Source #

serialiseValueIdentity :: (Eq v, SerialiseValue v) => v -> Bool Source #

Test the Identity law for the SerialiseValue class

serialiseValueIdentityUpToSlicing :: (Eq v, SerialiseValue v) => RawBytes -> v -> RawBytes -> Bool Source #

Test the Identity up to slicing law for the SerialiseValue class

newtype RawBytes Source #

Raw bytes with no alignment constraint (i.e. byte aligned), and no guarantee of pinned or unpinned memory (i.e. could be either).

Constructors

RawBytes (Vector Word8)

Instances

Instances details

IsString RawBytes Source #	Mostly to make test cases shorter to write.
Instance details Defined in Database.LSMTree.Internal.RawBytes Methods fromString :: String -> RawBytes #
Monoid RawBytes Source #
Instance details Defined in Database.LSMTree.Internal.RawBytes Methods mempty :: RawBytes # mappend :: RawBytes -> RawBytes -> RawBytes # mconcat :: [RawBytes] -> RawBytes #
Semigroup RawBytes Source #
Instance details Defined in Database.LSMTree.Internal.RawBytes Methods (<>) :: RawBytes -> RawBytes -> RawBytes # sconcat :: NonEmpty RawBytes -> RawBytes # stimes :: Integral b => b -> RawBytes -> RawBytes #
IsList RawBytes Source #
Instance details Defined in Database.LSMTree.Internal.RawBytes Associated Types type Item RawBytes # Methods fromList :: [Item RawBytes] -> RawBytes # fromListN :: Int -> [Item RawBytes] -> RawBytes # toList :: RawBytes -> [Item RawBytes] #
Show RawBytes Source #
Instance details Defined in Database.LSMTree.Internal.RawBytes Methods showsPrec :: Int -> RawBytes -> ShowS # show :: RawBytes -> String # showList :: [RawBytes] -> ShowS #
NFData RawBytes Source #
Instance details Defined in Database.LSMTree.Internal.RawBytes Methods rnf :: RawBytes -> () #
Eq RawBytes Source #
Instance details Defined in Database.LSMTree.Internal.RawBytes Methods (==) :: RawBytes -> RawBytes -> Bool # (/=) :: RawBytes -> RawBytes -> Bool #
Ord RawBytes Source #	Lexicographical `Ord` instance.
Instance details Defined in Database.LSMTree.Internal.RawBytes Methods compare :: RawBytes -> RawBytes -> Ordering # (<) :: RawBytes -> RawBytes -> Bool # (<=) :: RawBytes -> RawBytes -> Bool # (>) :: RawBytes -> RawBytes -> Bool # (>=) :: RawBytes -> RawBytes -> Bool # max :: RawBytes -> RawBytes -> RawBytes # min :: RawBytes -> RawBytes -> RawBytes #
Hashable RawBytes Source #
Instance details Defined in Database.LSMTree.Internal.RawBytes Methods hashSalt64 :: Word64 -> RawBytes -> Word64 Source #
type Item RawBytes Source #
Instance details Defined in Database.LSMTree.Internal.RawBytes type Item RawBytes = Word8

packSlice :: RawBytes -> RawBytes -> RawBytes -> RawBytes Source #

packSlice prefix x suffix makes x into a slice with prefix bytes on the left and suffix bytes on the right.

Errors

requireBytesExactly :: String -> Int -> Int -> a -> a Source #

requireBytesExactly tyName expected actual x