KeyedVals.Handle

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

Handle and related types and functions

data Handle m

A handle for accessing the ValsByKey store.

data HandleErr

Represents the errors that might arise in Handle functions

Constructors

ConnectionClosed

Unanticipated !Text

NotDecoded !Text

BadKey

Gone !Key

Instances

Exception HandleErr

Defined in KeyedVals.Handle.Internal

Methods

toException :: HandleErr -> SomeException

fromException :: SomeException -> Maybe HandleErr

displayException :: HandleErr -> String

Show HandleErr

Defined in KeyedVals.Handle.Internal

Methods

showsPrec :: Int -> HandleErr -> ShowS

show :: HandleErr -> String

showList :: [HandleErr] -> ShowS

Eq HandleErr

Defined in KeyedVals.Handle.Internal

Methods

(==) :: HandleErr -> HandleErr -> Bool

(/=) :: HandleErr -> HandleErr -> Bool

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

Determines the number of Vals in a ValsByKey.

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

Loads the saved Val corresponding to a Key.

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

Saves a Val for Key.

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

Loads a ValsByKey.

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

Saves a ValsByKey .

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

Updates the stored ValsByKey from the given ValsByKey.

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

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

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

Loads a Val from a ValsByKey.

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

Saves a Val in a ValsByKey.

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

Deletes Vals stored with the given Keys.

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

Deletes Vals for the given Keys from a ValsByKey.

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

Deletes Vals whose Keys match a Glob.

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

Deletes Vals whose Keys match a Glob from a ValsByKey

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

Deletes Vals that match a Selection.

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

Deletes Vals whose Keys match a Selection from a ValsByKey

Selection and Glob

data Selection

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

Show Selection

Defined in KeyedVals.Handle.Internal

Methods

showsPrec :: Int -> Selection -> ShowS

show :: Selection -> String

showList :: [Selection] -> ShowS

Eq Selection

Defined in KeyedVals.Handle.Internal

Methods

(==) :: Selection -> Selection -> Bool

(/=) :: Selection -> Selection -> Bool

data Glob

Represents a redis glob use to select keys

Instances

Show Glob

Defined in KeyedVals.Handle.Internal

Methods

showsPrec :: Int -> Glob -> ShowS

show :: Glob -> String

showList :: [Glob] -> ShowS

Eq Glob

Defined in KeyedVals.Handle.Internal

Methods

(==) :: Glob -> Glob -> Bool

(/=) :: Glob -> Glob -> Bool

mkGlob :: ByteString -> Maybe Glob

constructor for a Glob

returns Nothing if the pattern is invalid

isIn :: ByteString -> Selection -> Bool

tests if a ByteString matches a Selection

aliases used by the Handle functions

type Key = ByteString

Represents a key used to store a Value.

type Val = ByteString

Represents a value stored in the service.

type ValsByKey = Map Key Val

Represents a related group of Values stored by Key.