KeyedVals.Handle.Internal

Declares the abstract Handle

types used in the Handle functions

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

FromHandleErr HandleErr

Defined in KeyedVals.Handle.Codec

Methods

fromHandleErr :: HandleErr -> HandleErr

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

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

the abstract Handle

data Handle m

A handle for accessing the ValsByKey store.

Constructors

Handle

Fields

• hLoadVal :: !(Key -> m (Either HandleErr (Maybe Val)))
• hSaveVal :: !(Key -> Val -> m (Either HandleErr ()))
• hCountKVs :: !(Key -> m (Either HandleErr Natural))
• hLoadKVs :: !(Key -> m (Either HandleErr ValsByKey))
• hSaveKVs :: !(Key -> ValsByKey -> m (Either HandleErr ()))
• hUpdateKVs :: !(Key -> ValsByKey -> m (Either HandleErr ()))
• hLoadFrom :: !(Key -> Key -> m (Either HandleErr (Maybe Val)))
• hSaveTo :: !(Key -> Key -> Val -> m (Either HandleErr ()))
• hLoadSlice :: !(Key -> Selection -> m (Either HandleErr ValsByKey))
• hDeleteSelected :: !(Selection -> m (Either HandleErr ()))
• hDeleteSelectedKVs :: !(Key -> Selection -> m (Either HandleErr ()))
• hClose :: !(m ())

aliases used in the Handle functions

type Key = ByteString

Represents a key used to store a Val.

type Val = ByteString

Represents a value stored in the service.

type ValsByKey = Map Key Val

Represents a related group of Vals stored by Key.