repository/io.github.maniramezan.kenwork.repository/LocalDataSource

LocalDataSource

interface LocalDataSource<E : Any>

The local persistence side of a Repository. Mirrors SwiftyNetwork's LocalDataSource.

Type Parameters

the stored entity type.

Inheritors

CacheBasedLocalDataSource

Functions

changes

open fun changes(): Flow<CacheChange>

A hot stream of CacheChanges for the underlying store, enabling reactive reads via Repository.stream. The default is an empty flow (non-reactive source).

entry

open suspend fun entry(key: CacheKey): CacheEntry<E>?

Atomically returns the entity and its timestamp for key, or null if absent.

read

abstract suspend fun read(key: CacheKey): E?

Returns the entity stored for key, or null.

remove

abstract suspend fun remove(key: CacheKey)

Removes the entity stored for key.

removeAll

abstract suspend fun removeAll()

Removes all stored entities.

timestamp

abstract suspend fun timestamp(key: CacheKey): Long?

Returns the epoch-millisecond timestamp recorded for key, or null.

write

abstract suspend fun write(entity: E, key: CacheKey)

Stores entity for key.