Safe Haskell	Safe-Inferred
Language	GHC2021

Butler.Core.Storage

Contents

Read/Write

Synopsis

data Storage
newStorage :: MonadIO m => RawFilePath -> m Storage
getStoragePath :: Storage -> StorageAddress -> RawFilePath
scopeStorage :: MonadIO m => Storage -> StorageAddress -> m Storage
syncThread :: MonadIO m => Storage -> (Int -> m ()) -> m Void
newtype StorageAddress = StorageAddress ByteString
writeStorage :: Storage -> StorageAddress -> LByteString -> STM ()
readStorage :: MonadIO m => Storage -> StorageAddress -> m (Maybe LByteString)

Documentation

data Storage #

newStorage :: MonadIO m => RawFilePath -> m Storage #

getStoragePath :: Storage -> StorageAddress -> RawFilePath #

scopeStorage :: MonadIO m => Storage -> StorageAddress -> m Storage #

syncThread :: MonadIO m => Storage -> (Int -> m ()) -> m Void #

The syncThread must be started for the storage to persist

Read/Write

newtype StorageAddress #

Constructors

StorageAddress ByteString

Instances

Instances details

IsString StorageAddress #
Instance details Defined in Butler.Core.Storage Methods fromString :: String -> StorageAddress #
Semigroup StorageAddress #
Instance details Defined in Butler.Core.Storage Methods (<>) :: StorageAddress -> StorageAddress -> StorageAddress # sconcat :: NonEmpty StorageAddress -> StorageAddress # stimes :: Integral b => b -> StorageAddress -> StorageAddress #
Show StorageAddress #
Instance details Defined in Butler.Core.Storage Methods showsPrec :: Int -> StorageAddress -> ShowS # show :: StorageAddress -> String # showList :: [StorageAddress] -> ShowS #
Eq StorageAddress #
Instance details Defined in Butler.Core.Storage Methods (==) :: StorageAddress -> StorageAddress -> Bool # (/=) :: StorageAddress -> StorageAddress -> Bool #
Ord StorageAddress #
Instance details Defined in Butler.Core.Storage Methods compare :: StorageAddress -> StorageAddress -> Ordering # (<) :: StorageAddress -> StorageAddress -> Bool # (<=) :: StorageAddress -> StorageAddress -> Bool # (>) :: StorageAddress -> StorageAddress -> Bool # (>=) :: StorageAddress -> StorageAddress -> Bool # max :: StorageAddress -> StorageAddress -> StorageAddress # min :: StorageAddress -> StorageAddress -> StorageAddress #
Serialise StorageAddress #
Instance details Defined in Butler.Core.Storage Methods encode :: StorageAddress -> Encoding # decode :: Decoder s StorageAddress # encodeList :: [StorageAddress] -> Encoding # decodeList :: Decoder s [StorageAddress] #
From SessionID StorageAddress #
Instance details Defined in Butler.Display.Session Methods from :: SessionID -> StorageAddress #
From Workspace StorageAddress #
Instance details Defined in Butler.Display.WebSocket Methods from :: Workspace -> StorageAddress #
From Text StorageAddress #
Instance details Defined in Butler.Core.Storage Methods from :: Text -> StorageAddress #

writeStorage :: Storage -> StorageAddress -> LByteString -> STM () #

readStorage :: MonadIO m => Storage -> StorageAddress -> m (Maybe LByteString) #