GI.Soup.Objects.Cache

Exported types

newtype Cache

Constructors

Cache (ManagedPtr Cache)

Instances

GObject Cache

Methods

gobjectType :: Cache -> IO GType

IsObject Cache

IsSessionFeature Cache

IsCache Cache

((~) * info (ResolveCacheMethod t Cache), MethodInfo * info Cache p) => IsLabel t (Cache -> p)

Methods

fromLabel :: Proxy# Symbol t -> Cache -> p

((~) * info (ResolveCacheMethod t Cache), MethodInfo * info Cache p) => IsLabelProxy t (Cache -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Cache -> p

HasAttributeList * Cache

type AttributeList Cache

type AttributeList Cache

type SignalList Cache

type SignalList Cache

class GObject o => IsCache o

Instances

(GObject a, UnknownAncestorError Constraint Cache a) => IsCache a

IsCache Cache

toCache :: IsCache o => o -> IO Cache

noCache :: Maybe Cache

Methods

clear

data CacheClearMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsCache a) => MethodInfo * CacheClearMethodInfo a signature

Methods

overloadedMethod :: MethodProxy CacheClearMethodInfo a -> signature -> s

cacheClear

Arguments

:: (HasCallStack, MonadIO m, IsCache a)

=> a

cache: a Cache

-> m ()

Will remove all entries in the cache plus all the cache files.

Since: 2.34

dump

data CacheDumpMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsCache a) => MethodInfo * CacheDumpMethodInfo a signature

Methods

overloadedMethod :: MethodProxy CacheDumpMethodInfo a -> signature -> s

cacheDump

Arguments

:: (HasCallStack, MonadIO m, IsCache a)

=> a

cache: a Cache

-> m ()

Synchronously writes the cache index out to disk. Contrast with cacheFlush, which writes pending cache <emphasis>entries</emphasis> to disk.

You must call this before exiting if you want your cache data to persist between sessions.

@since 2.34.

flush

data CacheFlushMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsCache a) => MethodInfo * CacheFlushMethodInfo a signature

Methods

overloadedMethod :: MethodProxy CacheFlushMethodInfo a -> signature -> s

cacheFlush

Arguments

:: (HasCallStack, MonadIO m, IsCache a)

=> a

cache: a Cache

-> m ()

This function will force all pending writes in the cache to be committed to disk. For doing so it will iterate the MainContext associated with cache's session as long as needed.

Contrast with cacheDump, which writes out the cache index file.

Since: 2.34

getMaxSize

data CacheGetMaxSizeMethodInfo

Instances

((~) * signature (m Word32), MonadIO m, IsCache a) => MethodInfo * CacheGetMaxSizeMethodInfo a signature

Methods

overloadedMethod :: MethodProxy CacheGetMaxSizeMethodInfo a -> signature -> s

cacheGetMaxSize

Arguments

:: (HasCallStack, MonadIO m, IsCache a)

=> a

cache: a Cache

-> m Word32

Returns: the maximum size of the cache, in bytes.

Gets the maximum size of the cache.

Since: 2.34

load

data CacheLoadMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsCache a) => MethodInfo * CacheLoadMethodInfo a signature

Methods

overloadedMethod :: MethodProxy CacheLoadMethodInfo a -> signature -> s

cacheLoad

Arguments

:: (HasCallStack, MonadIO m, IsCache a)

=> a

cache: a Cache

-> m ()

Loads the contents of cache's index into memory.

Since: 2.34

new

cacheNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

cacheDir: the directory to store the cached data, or Nothing to use the default one

-> CacheType

cacheType: the CacheType of the cache

-> m Cache

Returns: a new Cache

Creates a new Cache.

Since: 2.34

setMaxSize

data CacheSetMaxSizeMethodInfo

Instances

((~) * signature (Word32 -> m ()), MonadIO m, IsCache a) => MethodInfo * CacheSetMaxSizeMethodInfo a signature

Methods

overloadedMethod :: MethodProxy CacheSetMaxSizeMethodInfo a -> signature -> s

cacheSetMaxSize

Arguments

:: (HasCallStack, MonadIO m, IsCache a)

=> a

cache: a Cache

-> Word32

maxSize: the maximum size of the cache, in bytes

-> m ()

Sets the maximum size of the cache.

Since: 2.34

Properties

cacheDir

data CacheCacheDirPropertyInfo

Instances

AttrInfo CacheCacheDirPropertyInfo

Associated Types

type AttrAllowedOps CacheCacheDirPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint CacheCacheDirPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint CacheCacheDirPropertyInfo :: * -> Constraint

type AttrGetType CacheCacheDirPropertyInfo :: *

type AttrLabel CacheCacheDirPropertyInfo :: Symbol

type AttrOrigin CacheCacheDirPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint CacheCacheDirPropertyInfo o => Proxy * CacheCacheDirPropertyInfo -> o -> IO (AttrGetType CacheCacheDirPropertyInfo)

attrSet :: (AttrBaseTypeConstraint CacheCacheDirPropertyInfo o, AttrSetTypeConstraint CacheCacheDirPropertyInfo b) => Proxy * CacheCacheDirPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint CacheCacheDirPropertyInfo o => Proxy * CacheCacheDirPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint CacheCacheDirPropertyInfo o, AttrSetTypeConstraint CacheCacheDirPropertyInfo b) => Proxy * CacheCacheDirPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin CacheCacheDirPropertyInfo

type AttrOrigin CacheCacheDirPropertyInfo = Cache

type AttrLabel CacheCacheDirPropertyInfo

type AttrLabel CacheCacheDirPropertyInfo = "cache-dir"

type AttrGetType CacheCacheDirPropertyInfo

type AttrGetType CacheCacheDirPropertyInfo = Maybe Text

type AttrBaseTypeConstraint CacheCacheDirPropertyInfo

type AttrBaseTypeConstraint CacheCacheDirPropertyInfo = IsCache

type AttrSetTypeConstraint CacheCacheDirPropertyInfo

type AttrSetTypeConstraint CacheCacheDirPropertyInfo = * ~ Text

type AttrAllowedOps CacheCacheDirPropertyInfo

type AttrAllowedOps CacheCacheDirPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

cacheCacheDir :: AttrLabelProxy "cacheDir"

constructCacheCacheDir :: IsCache o => Text -> IO (GValueConstruct o)

getCacheCacheDir :: (MonadIO m, IsCache o) => o -> m (Maybe Text)

cacheType

data CacheCacheTypePropertyInfo

Instances

AttrInfo CacheCacheTypePropertyInfo

Associated Types

type AttrAllowedOps CacheCacheTypePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint CacheCacheTypePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint CacheCacheTypePropertyInfo :: * -> Constraint

type AttrGetType CacheCacheTypePropertyInfo :: *

type AttrLabel CacheCacheTypePropertyInfo :: Symbol

type AttrOrigin CacheCacheTypePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint CacheCacheTypePropertyInfo o => Proxy * CacheCacheTypePropertyInfo -> o -> IO (AttrGetType CacheCacheTypePropertyInfo)

attrSet :: (AttrBaseTypeConstraint CacheCacheTypePropertyInfo o, AttrSetTypeConstraint CacheCacheTypePropertyInfo b) => Proxy * CacheCacheTypePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint CacheCacheTypePropertyInfo o => Proxy * CacheCacheTypePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint CacheCacheTypePropertyInfo o, AttrSetTypeConstraint CacheCacheTypePropertyInfo b) => Proxy * CacheCacheTypePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin CacheCacheTypePropertyInfo

type AttrOrigin CacheCacheTypePropertyInfo = Cache

type AttrLabel CacheCacheTypePropertyInfo

type AttrLabel CacheCacheTypePropertyInfo = "cache-type"

type AttrGetType CacheCacheTypePropertyInfo

type AttrGetType CacheCacheTypePropertyInfo = CacheType

type AttrBaseTypeConstraint CacheCacheTypePropertyInfo

type AttrBaseTypeConstraint CacheCacheTypePropertyInfo = IsCache

type AttrSetTypeConstraint CacheCacheTypePropertyInfo

type AttrSetTypeConstraint CacheCacheTypePropertyInfo = * ~ CacheType

type AttrAllowedOps CacheCacheTypePropertyInfo

type AttrAllowedOps CacheCacheTypePropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag))

cacheCacheType :: AttrLabelProxy "cacheType"

constructCacheCacheType :: IsCache o => CacheType -> IO (GValueConstruct o)

getCacheCacheType :: (MonadIO m, IsCache o) => o -> m CacheType