Copyright	(c) 2018-2022 Tim Emiola
License	BSD3
Maintainer	Tim Emiola <tim@emio.la>
Safe Haskell	Safe-Inferred
Language	Haskell2010

KeyedVals.Handle

Contents

Handle and related types and functions
Selection and Glob
aliases used by the Handle functions

Description

Declares the abstract Handle and combinators used to load and save keyed values.

Synopsis

data Handle m
data HandleErr
- = ConnectionClosed
- | Unanticipated !Text
- | NotDecoded !Text
- | BadKey
- | Gone !Key
countKVs :: Handle m -> Key -> m (Either HandleErr Natural)
loadVal :: Handle m -> Key -> m (Either HandleErr (Maybe Val))
saveVal :: Handle m -> Key -> Val -> m (Either HandleErr ())
loadKVs :: Handle m -> Key -> m (Either HandleErr ValsByKey)
saveKVs :: Handle m -> Key -> ValsByKey -> m (Either HandleErr ())
updateKVs :: Handle m -> Key -> ValsByKey -> m (Either HandleErr ())
loadSlice :: Handle m -> Key -> Selection -> m (Either HandleErr ValsByKey)
loadFrom :: Handle m -> Key -> Key -> m (Either HandleErr (Maybe Val))
saveTo :: Handle m -> Key -> Key -> Val -> m (Either HandleErr ())
deleteKeys :: Handle m -> NonEmpty Key -> m (Either HandleErr ())
deleteKeysFrom :: Handle m -> Key -> NonEmpty Key -> m (Either HandleErr ())
deleteMatches :: Handle m -> Glob -> m (Either HandleErr ())
deleteMatchesFrom :: Handle m -> Key -> Glob -> m (Either HandleErr ())
deleteSelected :: Handle m -> Selection -> m (Either HandleErr ())
deleteSelectedFrom :: Handle m -> Key -> Selection -> m (Either HandleErr ())
data Selection
- = Match !Glob
- | AllOf !(NonEmpty Key)
data Glob
mkGlob :: ByteString -> Maybe Glob
isIn :: ByteString -> Selection -> Bool
type Key = ByteString
type Val = ByteString
type ValsByKey = Map Key Val

`Handle` and related types and functions

data Handle m Source #

A handle for accessing the ValsByKey store.

data HandleErr Source #

Represents the errors that might arise in Handle functions

Constructors

ConnectionClosed
Unanticipated !Text
NotDecoded !Text
BadKey
Gone !Key

Instances

Instances details

Exception HandleErr Source #
Instance details Defined in KeyedVals.Handle.Internal Methods toException :: HandleErr -> SomeException # fromException :: SomeException -> Maybe HandleErr # displayException :: HandleErr -> String #
Show HandleErr Source #
Instance details Defined in KeyedVals.Handle.Internal Methods showsPrec :: Int -> HandleErr -> ShowS # show :: HandleErr -> String # showList :: [HandleErr] -> ShowS #
Eq HandleErr Source #
Instance details Defined in KeyedVals.Handle.Internal Methods (==) :: HandleErr -> HandleErr -> Bool # (/=) :: HandleErr -> HandleErr -> Bool #
FromHandleErr HandleErr Source #
Instance details Defined in KeyedVals.Handle.Codec Methods fromHandleErr :: HandleErr -> HandleErr Source #

countKVs :: Handle m -> Key -> m (Either HandleErr Natural) Source #

Determines the number of Vals in a ValsByKey.

loadVal :: Handle m -> Key -> m (Either HandleErr (Maybe Val)) Source #

Loads the saved Val corresponding to a Key.

saveVal :: Handle m -> Key -> Val -> m (Either HandleErr ()) Source #

Saves a Val for Key.

loadKVs :: Handle m -> Key -> m (Either HandleErr ValsByKey) Source #

Loads a ValsByKey.

saveKVs :: Handle m -> Key -> ValsByKey -> m (Either HandleErr ()) Source #

Saves a ValsByKey .

updateKVs :: Handle m -> Key -> ValsByKey -> m (Either HandleErr ()) Source #

Updates the stored ValsByKey from the given ValsByKey.

loadSlice :: Handle m -> Key -> Selection -> m (Either HandleErr ValsByKey) Source #

Loads a ValsByKey that only includes Vals whose keys match a Selection.

loadFrom :: Handle m -> Key -> Key -> m (Either HandleErr (Maybe Val)) Source #

Loads a Val from a ValsByKey.

saveTo :: Handle m -> Key -> Key -> Val -> m (Either HandleErr ()) Source #

Saves a Val in a ValsByKey.

deleteKeys :: Handle m -> NonEmpty Key -> m (Either HandleErr ()) Source #

Deletes Vals stored with the given Keys.

deleteKeysFrom :: Handle m -> Key -> NonEmpty Key -> m (Either HandleErr ()) Source #

Deletes Vals for the given Keys from a ValsByKey.

deleteMatches :: Handle m -> Glob -> m (Either HandleErr ()) Source #

Deletes Vals whose Keys match a Glob.

deleteMatchesFrom :: Handle m -> Key -> Glob -> m (Either HandleErr ()) Source #

Deletes Vals whose Keys match a Glob from a ValsByKey

deleteSelected :: Handle m -> Selection -> m (Either HandleErr ()) Source #

Deletes Vals that match a Selection.

deleteSelectedFrom :: Handle m -> Key -> Selection -> m (Either HandleErr ()) Source #

Deletes Vals whose Keys match a Selection from a ValsByKey

`Selection` and `Glob`

data Selection Source #

Represents ways of restricting the keys used in a ValsByKey

Constructors

Match !Glob	any keys that match the glob pattern
AllOf !(NonEmpty Key)	any of the specified keys

Instances

Instances details

Show Selection Source #
Instance details Defined in KeyedVals.Handle.Internal Methods showsPrec :: Int -> Selection -> ShowS # show :: Selection -> String # showList :: [Selection] -> ShowS #
Eq Selection Source #
Instance details Defined in KeyedVals.Handle.Internal Methods (==) :: Selection -> Selection -> Bool # (/=) :: Selection -> Selection -> Bool #

data Glob Source #

Represents a redis glob use to select keys

Instances

Instances details

Show Glob Source #
Instance details Defined in KeyedVals.Handle.Internal Methods showsPrec :: Int -> Glob -> ShowS # show :: Glob -> String # showList :: [Glob] -> ShowS #
Eq Glob Source #
Instance details Defined in KeyedVals.Handle.Internal Methods (==) :: Glob -> Glob -> Bool # (/=) :: Glob -> Glob -> Bool #