Safe Haskell	Safe-Inferred
Language	GHC2021

Database.LSMTree.Internal.Serialise

Contents

Re-exports
Keys
Values
Blobs

Description

Newtype wrappers and utilities for serialised keys, values and blobs.

Synopsis

class SerialiseKey k
class SerialiseValue v
newtype SerialisedKey where
- SerialisedKey RawBytes
- pattern SerialisedKey' :: Vector Word8 -> SerialisedKey
serialiseKey :: SerialiseKey k => k -> SerialisedKey
deserialiseKey :: SerialiseKey k => SerialisedKey -> k
sizeofKey :: SerialisedKey -> Int
sizeofKey16 :: SerialisedKey -> Word16
sizeofKey32 :: SerialisedKey -> Word32
sizeofKey64 :: SerialisedKey -> Word64
serialisedKey :: SerialisedKey -> Builder
keyTopBits64 :: SerialisedKey -> Word64
newtype SerialisedValue where
- SerialisedValue RawBytes
- pattern SerialisedValue' :: Vector Word8 -> SerialisedValue
serialiseValue :: SerialiseValue v => v -> SerialisedValue
deserialiseValue :: SerialiseValue v => SerialisedValue -> v
sizeofValue :: SerialisedValue -> Int
sizeofValue16 :: SerialisedValue -> Word16
sizeofValue32 :: SerialisedValue -> Word32
sizeofValue64 :: SerialisedValue -> Word64
serialisedValue :: SerialisedValue -> Builder
type ResolveSerialisedValue = SerialisedValue -> SerialisedValue -> SerialisedValue
newtype SerialisedBlob where
- SerialisedBlob RawBytes
- pattern SerialisedBlob' :: Vector Word8 -> SerialisedBlob
serialiseBlob :: SerialiseValue v => v -> SerialisedBlob
deserialiseBlob :: SerialiseValue v => SerialisedBlob -> v
sizeofBlob :: SerialisedBlob -> Int
sizeofBlob64 :: SerialisedBlob -> Word64
serialisedBlob :: SerialisedBlob -> Builder

Re-exports

class SerialiseKey k Source #

Serialisation of keys.

Instances should satisfy the following laws:

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

Minimal complete definition

serialiseKey, deserialiseKey

Instances

Instances details

SerialiseKey ByteArray Source #	`serialiseKey`: \(O(1)\). `deserialiseKey`: \(O(n)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseKey :: ByteArray -> RawBytes Source # deserialiseKey :: RawBytes -> ByteArray Source #
SerialiseKey Void Source #	The implementation of `deserialiseKey` throws an exception.
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseKey :: Void -> RawBytes Source # deserialiseKey :: RawBytes -> Void Source #
SerialiseKey Int16 Source #	`serialiseKey`: \(O(1)\). `deserialiseKey`: \(O(1)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseKey :: Int16 -> RawBytes Source # deserialiseKey :: RawBytes -> Int16 Source #
SerialiseKey Int32 Source #	`serialiseKey`: \(O(1)\). `deserialiseKey`: \(O(1)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseKey :: Int32 -> RawBytes Source # deserialiseKey :: RawBytes -> Int32 Source #
SerialiseKey Int64 Source #	`serialiseKey`: \(O(1)\). `deserialiseKey`: \(O(1)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseKey :: Int64 -> RawBytes Source # deserialiseKey :: RawBytes -> Int64 Source #
SerialiseKey Int8 Source #	`serialiseKey`: \(O(1)\). `deserialiseKey`: \(O(1)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseKey :: Int8 -> RawBytes Source # deserialiseKey :: RawBytes -> Int8 Source #
SerialiseKey Word16 Source #	`serialiseKey`: \(O(1)\). `deserialiseKey`: \(O(1)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseKey :: Word16 -> RawBytes Source # deserialiseKey :: RawBytes -> Word16 Source #
SerialiseKey Word32 Source #	`serialiseKey`: \(O(1)\). `deserialiseKey`: \(O(1)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseKey :: Word32 -> RawBytes Source # deserialiseKey :: RawBytes -> Word32 Source #
SerialiseKey Word64 Source #	`serialiseKey`: \(O(1)\). `deserialiseKey`: \(O(1)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseKey :: Word64 -> RawBytes Source # deserialiseKey :: RawBytes -> Word64 Source #
SerialiseKey Word8 Source #	`serialiseKey`: \(O(1)\). `deserialiseKey`: \(O(1)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseKey :: Word8 -> RawBytes Source # deserialiseKey :: RawBytes -> Word8 Source #
SerialiseKey ByteString Source #	`serialiseKey`: \(O(n)\). `deserialiseKey`: \(O(n)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseKey :: ByteString -> RawBytes Source # deserialiseKey :: RawBytes -> ByteString Source #
SerialiseKey ByteString Source #	`serialiseKey`: \(O(n)\). `deserialiseKey`: \(O(n)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseKey :: ByteString -> RawBytes Source # deserialiseKey :: RawBytes -> ByteString Source #
SerialiseKey ShortByteString Source #	`serialiseKey`: \(O(1)\). `deserialiseKey`: \(O(n)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseKey :: ShortByteString -> RawBytes Source # deserialiseKey :: RawBytes -> ShortByteString Source #
SerialiseKey String Source #	`serialiseKey`: \(O(n)\). `deserialiseKey`: \(O(n)\). The `String` is (de)serialised as UTF-8.
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseKey :: String -> RawBytes Source # deserialiseKey :: RawBytes -> String Source #
SerialiseKey Int Source #	`serialiseKey`: \(O(1)\). `deserialiseKey`: \(O(1)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseKey :: Int -> RawBytes Source # deserialiseKey :: RawBytes -> Int Source #
SerialiseKey Word Source #	`serialiseKey`: \(O(1)\). `deserialiseKey`: \(O(1)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseKey :: Word -> RawBytes Source # deserialiseKey :: RawBytes -> Word Source #

class SerialiseValue v Source #

Serialisation of values and blobs.

Instances should satisfy the following laws:

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

Minimal complete definition

serialiseValue, deserialiseValue

Instances

Instances details

SerialiseValue ByteArray Source #	`serialiseValue`: \(O(1)\). `deserialiseValue`: \(O(n)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseValue :: ByteArray -> RawBytes Source # deserialiseValue :: RawBytes -> ByteArray Source #
SerialiseValue Void Source #	The implementation of `deserialiseValue` throws an exception.
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseValue :: Void -> RawBytes Source # deserialiseValue :: RawBytes -> Void Source #
SerialiseValue Int16 Source #	`serialiseValue`: \(O(1)\). `deserialiseValue`: \(O(1)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseValue :: Int16 -> RawBytes Source # deserialiseValue :: RawBytes -> Int16 Source #
SerialiseValue Int32 Source #	`serialiseValue`: \(O(1)\). `deserialiseValue`: \(O(1)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseValue :: Int32 -> RawBytes Source # deserialiseValue :: RawBytes -> Int32 Source #
SerialiseValue Int64 Source #	`serialiseValue`: \(O(1)\). `deserialiseValue`: \(O(1)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseValue :: Int64 -> RawBytes Source # deserialiseValue :: RawBytes -> Int64 Source #
SerialiseValue Int8 Source #	`serialiseValue`: \(O(1)\). `deserialiseValue`: \(O(1)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseValue :: Int8 -> RawBytes Source # deserialiseValue :: RawBytes -> Int8 Source #
SerialiseValue Word16 Source #	`serialiseValue`: \(O(1)\). `deserialiseValue`: \(O(1)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseValue :: Word16 -> RawBytes Source # deserialiseValue :: RawBytes -> Word16 Source #
SerialiseValue Word32 Source #	`serialiseValue`: \(O(1)\). `deserialiseValue`: \(O(1)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseValue :: Word32 -> RawBytes Source # deserialiseValue :: RawBytes -> Word32 Source #
SerialiseValue Word64 Source #	`serialiseValue`: \(O(1)\). `deserialiseValue`: \(O(1)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseValue :: Word64 -> RawBytes Source # deserialiseValue :: RawBytes -> Word64 Source #
SerialiseValue Word8 Source #	`serialiseValue`: \(O(1)\). `deserialiseValue`: \(O(1)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseValue :: Word8 -> RawBytes Source # deserialiseValue :: RawBytes -> Word8 Source #
SerialiseValue ByteString Source #	`serialiseValue`: \(O(n)\). `deserialiseValue`: \(O(n)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseValue :: ByteString -> RawBytes Source # deserialiseValue :: RawBytes -> ByteString Source #
SerialiseValue ByteString Source #	`serialiseValue`: \(O(n)\). `deserialiseValue`: \(O(n)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseValue :: ByteString -> RawBytes Source # deserialiseValue :: RawBytes -> ByteString Source #
SerialiseValue ShortByteString Source #	`serialiseValue`: \(O(1)\). `deserialiseValue`: \(O(n)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseValue :: ShortByteString -> RawBytes Source # deserialiseValue :: RawBytes -> ShortByteString Source #
SerialiseValue String Source #	`serialiseKey`: \(O(n)\). `deserialiseKey`: \(O(n)\). The `String` is (de)serialised as UTF-8.
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseValue :: String -> RawBytes Source # deserialiseValue :: RawBytes -> String Source #
SerialiseValue Int Source #	`serialiseValue`: \(O(1)\). `deserialiseValue`: \(O(1)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseValue :: Int -> RawBytes Source # deserialiseValue :: RawBytes -> Int Source #
SerialiseValue Word Source #	`serialiseValue`: \(O(1)\). `deserialiseValue`: \(O(1)\).
Instance details Defined in Database.LSMTree.Internal.Serialise.Class Methods serialiseValue :: Word -> RawBytes Source # deserialiseValue :: RawBytes -> Word Source #
SerialiseValue a => SerialiseValue (Sum a) Source #	An instance for `Sum` which is transparent to the serialisation of the value type. NOTE: If you want to serialise `Sum a` differently from `a`, you must use another newtype wrapper.
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.Internal.Types Methods serialiseValue :: ResolveAsFirst v -> RawBytes Source # deserialiseValue :: RawBytes -> ResolveAsFirst v Source #
SerialiseValue v => SerialiseValue (ResolveViaSemigroup v) Source #
Instance details Defined in Database.LSMTree.Internal.Types Methods serialiseValue :: ResolveViaSemigroup v -> RawBytes Source # deserialiseValue :: RawBytes -> ResolveViaSemigroup v Source #

Keys

newtype SerialisedKey Source #

Representation of a serialised key.

Serialisation should preserve equality and ordering. The Ord instance for SerialisedKey uses lexicographical ordering.

Constructors

SerialisedKey RawBytes

Bundled Patterns

pattern SerialisedKey' :: Vector Word8 -> SerialisedKey

Instances

Instances details

Show SerialisedKey Source #
Instance details Defined in Database.LSMTree.Internal.Serialise Methods showsPrec :: Int -> SerialisedKey -> ShowS # show :: SerialisedKey -> String # showList :: [SerialisedKey] -> ShowS #
Hashable SerialisedKey Source #
Instance details Defined in Database.LSMTree.Internal.Serialise Methods hashSalt64 :: Salt -> SerialisedKey -> Hash Source #
NFData SerialisedKey Source #
Instance details Defined in Database.LSMTree.Internal.Serialise Methods rnf :: SerialisedKey -> () #
Eq SerialisedKey Source #
Instance details Defined in Database.LSMTree.Internal.Serialise Methods (==) :: SerialisedKey -> SerialisedKey -> Bool # (/=) :: SerialisedKey -> SerialisedKey -> Bool #
Ord SerialisedKey Source #
Instance details Defined in Database.LSMTree.Internal.Serialise Methods compare :: SerialisedKey -> SerialisedKey -> Ordering # (<) :: SerialisedKey -> SerialisedKey -> Bool # (<=) :: SerialisedKey -> SerialisedKey -> Bool # (>) :: SerialisedKey -> SerialisedKey -> Bool # (>=) :: SerialisedKey -> SerialisedKey -> Bool # max :: SerialisedKey -> SerialisedKey -> SerialisedKey # min :: SerialisedKey -> SerialisedKey -> SerialisedKey #
Show (Unsliced SerialisedKey) Source #
Instance details Defined in Database.LSMTree.Internal.Unsliced Methods showsPrec :: Int -> Unsliced SerialisedKey -> ShowS # show :: Unsliced SerialisedKey -> String # showList :: [Unsliced SerialisedKey] -> ShowS #
Eq (Unsliced SerialisedKey) Source #
Instance details Defined in Database.LSMTree.Internal.Unsliced Methods (==) :: Unsliced SerialisedKey -> Unsliced SerialisedKey -> Bool # (/=) :: Unsliced SerialisedKey -> Unsliced SerialisedKey -> Bool #
Ord (Unsliced SerialisedKey) Source #
Instance details Defined in Database.LSMTree.Internal.Unsliced Methods compare :: Unsliced SerialisedKey -> Unsliced SerialisedKey -> Ordering # (<) :: Unsliced SerialisedKey -> Unsliced SerialisedKey -> Bool # (<=) :: Unsliced SerialisedKey -> Unsliced SerialisedKey -> Bool # (>) :: Unsliced SerialisedKey -> Unsliced SerialisedKey -> Bool # (>=) :: Unsliced SerialisedKey -> Unsliced SerialisedKey -> Bool # max :: Unsliced SerialisedKey -> Unsliced SerialisedKey -> Unsliced SerialisedKey # min :: Unsliced SerialisedKey -> Unsliced SerialisedKey -> Unsliced SerialisedKey #

serialiseKey :: SerialiseKey k => k -> SerialisedKey Source #

deserialiseKey :: SerialiseKey k => SerialisedKey -> k Source #

sizeofKey :: SerialisedKey -> Int Source #

Size of key in number of bytes.

sizeofKey16 :: SerialisedKey -> Word16 Source #

Size of key in number of bytes.

sizeofKey32 :: SerialisedKey -> Word32 Source #

Size of key in number of bytes.

sizeofKey64 :: SerialisedKey -> Word64 Source #

Size of key in number of bytes.

serialisedKey :: SerialisedKey -> Builder Source #

keyTopBits64 :: SerialisedKey -> Word64 Source #

See topBits64

Values

newtype SerialisedValue Source #

Representation of a serialised value.

Constructors

SerialisedValue RawBytes

Bundled Patterns

pattern SerialisedValue' :: Vector Word8 -> SerialisedValue

Instances

Instances details

Show SerialisedValue Source #
Instance details Defined in Database.LSMTree.Internal.Serialise Methods showsPrec :: Int -> SerialisedValue -> ShowS # show :: SerialisedValue -> String # showList :: [SerialisedValue] -> ShowS #
NFData SerialisedValue Source #
Instance details Defined in Database.LSMTree.Internal.Serialise Methods rnf :: SerialisedValue -> () #
Eq SerialisedValue Source #
Instance details Defined in Database.LSMTree.Internal.Serialise Methods (==) :: SerialisedValue -> SerialisedValue -> Bool # (/=) :: SerialisedValue -> SerialisedValue -> Bool #
Ord SerialisedValue Source #
Instance details Defined in Database.LSMTree.Internal.Serialise Methods compare :: SerialisedValue -> SerialisedValue -> Ordering # (<) :: SerialisedValue -> SerialisedValue -> Bool # (<=) :: SerialisedValue -> SerialisedValue -> Bool # (>) :: SerialisedValue -> SerialisedValue -> Bool # (>=) :: SerialisedValue -> SerialisedValue -> Bool # max :: SerialisedValue -> SerialisedValue -> SerialisedValue # min :: SerialisedValue -> SerialisedValue -> SerialisedValue #

serialiseValue :: SerialiseValue v => v -> SerialisedValue Source #

deserialiseValue :: SerialiseValue v => SerialisedValue -> v Source #

sizeofValue :: SerialisedValue -> Int Source #

sizeofValue16 :: SerialisedValue -> Word16 Source #

Size of value in number of bytes.

sizeofValue32 :: SerialisedValue -> Word32 Source #

Size of value in number of bytes.

sizeofValue64 :: SerialisedValue -> Word64 Source #

Size of value in number of bytes.

serialisedValue :: SerialisedValue -> Builder Source #

type ResolveSerialisedValue = SerialisedValue -> SerialisedValue -> SerialisedValue Source #

Blobs

newtype SerialisedBlob Source #

Representation of a serialised blob.

Constructors

SerialisedBlob RawBytes

Bundled Patterns

pattern SerialisedBlob' :: Vector Word8 -> SerialisedBlob

Instances

Instances details

Show SerialisedBlob Source #
Instance details Defined in Database.LSMTree.Internal.Serialise Methods showsPrec :: Int -> SerialisedBlob -> ShowS # show :: SerialisedBlob -> String # showList :: [SerialisedBlob] -> ShowS #
NFData SerialisedBlob Source #
Instance details Defined in Database.LSMTree.Internal.Serialise Methods rnf :: SerialisedBlob -> () #
Eq SerialisedBlob Source #
Instance details Defined in Database.LSMTree.Internal.Serialise Methods (==) :: SerialisedBlob -> SerialisedBlob -> Bool # (/=) :: SerialisedBlob -> SerialisedBlob -> Bool #
Ord SerialisedBlob Source #
Instance details Defined in Database.LSMTree.Internal.Serialise Methods compare :: SerialisedBlob -> SerialisedBlob -> Ordering # (<) :: SerialisedBlob -> SerialisedBlob -> Bool # (<=) :: SerialisedBlob -> SerialisedBlob -> Bool # (>) :: SerialisedBlob -> SerialisedBlob -> Bool # (>=) :: SerialisedBlob -> SerialisedBlob -> Bool # max :: SerialisedBlob -> SerialisedBlob -> SerialisedBlob # min :: SerialisedBlob -> SerialisedBlob -> SerialisedBlob #

serialiseBlob :: SerialiseValue v => v -> SerialisedBlob Source #

deserialiseBlob :: SerialiseValue v => SerialisedBlob -> v Source #

sizeofBlob :: SerialisedBlob -> Int Source #

Size of blob in number of bytes.

sizeofBlob64 :: SerialisedBlob -> Word64 Source #

serialisedBlob :: SerialisedBlob -> Builder Source #