cacheonhand-attendants/io.github.notoriouscorgi.cacheonhand.operations

Package-level declarations

Types

data class CacheableFireAndForgetMutationResult<TError : Throwable>(val fetchState: FetchState, val error: TError?) : CacheableResult<TError>

CacheableFireAndForgetMutationWithInput

class CacheableFireAndForgetMutationWithInput<TInput : CacheableInput.MutationInput, TError : Throwable>(howTo: suspend (input: TInput) -> Unit, cache: OnHandCache, dispatcher: CoroutineDispatcher = Dispatchers.Default)

CacheableFireAndForgetMutationWithNoInput

class CacheableFireAndForgetMutationWithNoInput<TError : Throwable>(howTo: suspend () -> Unit, cache: OnHandCache, dispatcher: CoroutineDispatcher = Dispatchers.Default)

CacheableFlowResult

data class CacheableFlowResult<TData, TError : Throwable>(val fetchState: FetchState, val error: TError?, val data: TData?) : CacheableResultWithData<TData, TError>

Cacheable flow operations for subscribing to reactive data sources (SSE, WebSockets, etc.) and writing each emission to the cache.

CacheableFlowWithInput

class CacheableFlowWithInput<TInput : CacheableInput.FlowInput, TData, TError : Throwable>(coroutineScope: CoroutineScope, launchFlow: (input: TInput) -> Flow<TData?>, startingCacheKey: TInput? = null, cache: OnHandCache, dispatcher: CoroutineDispatcher = Dispatchers.Default, ttl: Duration? = null, initialFetchState: FetchState = FetchState.IDLE)

CacheableFlowWithNoInput

class CacheableFlowWithNoInput<TData, TError : Throwable>(coroutineScope: CoroutineScope, launchFlow: () -> Flow<TData?>, val cacheKey: CacheableInput.FlowInput, cache: OnHandCache, dispatcher: CoroutineDispatcher = Dispatchers.Default, ttl: Duration? = null, initialFetchState: FetchState = FetchState.IDLE)

CacheableInfiniteQueryResult

data class CacheableInfiniteQueryResult<TPageParam, TData, TError : Throwable>(val fetchState: FetchState, val error: TError?, val data: List<PagedData<TPageParam?, TData>>? = null, val hasNextPage: Boolean = true, val hasPreviousPage: Boolean = false) : CacheableResultWithData<List<PagedData<TPageParam?, TData>>, TError>

CacheableInfiniteQueryWithInput

class CacheableInfiniteQueryWithInput<TInput : CacheableInput.QueryInput, TPageParam, TData, TError : Throwable>(coroutineScope: CoroutineScope, launchQuery: suspend (input: TInput, page: TPageParam?) -> TData?, initialPageParam: TPageParam? = null, getNextPageParam: suspend (pages: List<PagedData<TPageParam?, TData>>) -> PageParam<TPageParam>, getPreviousPageParam: suspend (pages: List<PagedData<TPageParam?, TData>>) -> PageParam<TPageParam>? = null, startingCacheKey: TInput? = null, cache: OnHandCache, dispatcher: CoroutineDispatcher = Dispatchers.Default, ttl: Duration? = null, initialFetchState: FetchState = FetchState.IDLE)

CacheableInfiniteQueryWithNoInput

class CacheableInfiniteQueryWithNoInput<TPageParam, TData, TError : Throwable>(coroutineScope: CoroutineScope, launchQuery: suspend (page: TPageParam?) -> TData?, initialPageParam: TPageParam? = null, getNextPageParam: suspend (pages: List<PagedData<TPageParam?, TData>>) -> PageParam<TPageParam>, getPreviousPageParam: suspend (pages: List<PagedData<TPageParam?, TData>>) -> PageParam<TPageParam>? = null, val cacheKey: CacheableInput.QueryInput, cache: OnHandCache, dispatcher: CoroutineDispatcher = Dispatchers.Default, ttl: Duration? = null, initialFetchState: FetchState = FetchState.IDLE)

CacheableMutationResult

data class CacheableMutationResult<TData, TError : Throwable>(val fetchState: FetchState, val error: TError?, val data: TData?) : CacheableResultWithData<TData, TError>

CacheableMutationWithInput

class CacheableMutationWithInput<TInput : CacheableInput.MutationInput, TData, TError : Throwable>(launchMutation: suspend (input: TInput) -> TData?, cache: OnHandCache, dispatcher: CoroutineDispatcher = Dispatchers.Default)

CacheableMutationWithNoInput

class CacheableMutationWithNoInput<TData, TError : Throwable>(launchMutation: suspend () -> TData?, cache: OnHandCache, dispatcher: CoroutineDispatcher = Dispatchers.Default)

CacheableQuery

interface CacheableQuery<TData, TError : Throwable> : CacheableResultWithData<TData, TError>

Interface for query-like results used in the compose layer.

CacheableQueryResult

data class CacheableQueryResult<TData, TError : Throwable>(val fetchState: FetchState, val error: TError?, val data: TData?) : CacheableResultWithData<TData, TError>

CacheableQueryWithInput

class CacheableQueryWithInput<TInput : CacheableInput.QueryInput, TData, TError : Throwable>(coroutineScope: CoroutineScope, launchQuery: suspend (input: TInput) -> TData?, startingCacheKey: TInput? = null, cache: OnHandCache, dispatcher: CoroutineDispatcher = Dispatchers.Default, ttl: Duration? = null, initialFetchState: FetchState = FetchState.IDLE)

CacheableQueryWithNoInput

class CacheableQueryWithNoInput<TData, TError : Throwable>(coroutineScope: CoroutineScope, launchQuery: suspend () -> TData?, val cacheKey: CacheableInput.QueryInput, cache: OnHandCache, dispatcher: CoroutineDispatcher = Dispatchers.Default, ttl: Duration? = null, initialFetchState: FetchState = FetchState.IDLE)

CacheableResult

interface CacheableResult<TError : Throwable>

Base interface for all cacheable operation results. Provides the fetch state and error information.

CacheableResultWithData

interface CacheableResultWithData<TData, TError : Throwable> : CacheableResult<TError>

Extended result interface that includes data. All results with data (query, mutation, flow, infinite query) implement this.

CacheAndFetchState

enum CacheAndFetchState : Enum<CacheAndFetchState>

FetchState

enum FetchState : Enum<FetchState>

Property to determine the fetch state of your data

FireAndForgetMutationFactoryWithInput

class FireAndForgetMutationFactoryWithInput<TInput : CacheableInput.MutationInput, TError : Throwable>(cache: OnHandCache, dispatcher: CoroutineDispatcher = Dispatchers.Default, mutation: suspend (input: TInput) -> Unit)

FireAndForgetMutationFactoryWithNoInput

class FireAndForgetMutationFactoryWithNoInput<TError : Throwable>(cache: OnHandCache, dispatcher: CoroutineDispatcher = Dispatchers.Default, mutation: suspend () -> Unit)

FlowFactoryWithInput

class FlowFactoryWithInput<TInput : CacheableInput.FlowInput, TData, TError : Throwable>(cache: OnHandCache, dispatcher: CoroutineDispatcher = Dispatchers.Default, ttl: Duration? = null, flow: (input: TInput) -> Flow<TData>)

Factory for creating CacheableFlowWithInput instances.

FlowFactoryWithNoInput

class FlowFactoryWithNoInput<TData, TError : Throwable>(cache: OnHandCache, cacheKey: CacheableInput.FlowInput, dispatcher: CoroutineDispatcher = Dispatchers.Default, ttl: Duration? = null, flow: () -> Flow<TData>)

Factory for creating CacheableFlowWithNoInput instances.

InfiniteQueryFactoryWithInput

class InfiniteQueryFactoryWithInput<TInput : CacheableInput.QueryInput, TPageParam, TData, TError : Throwable>(cache: OnHandCache, initialPageParam: TPageParam? = null, getNextPageParam: suspend (pages: List<PagedData<TPageParam?, TData>>) -> PageParam<TPageParam>, getPreviousPageParam: suspend (pages: List<PagedData<TPageParam?, TData>>) -> PageParam<TPageParam>? = null, dispatcher: CoroutineDispatcher = Dispatchers.Default, ttl: Duration? = null, query: suspend (input: TInput, page: TPageParam?) -> TData?)

InfiniteQueryFactoryWithNoInput

class InfiniteQueryFactoryWithNoInput<TPageParam, TData, TError : Throwable>(cache: OnHandCache, cacheKey: CacheableInput.QueryInput, initialPageParam: TPageParam? = null, getNextPageParam: suspend (pages: List<PagedData<TPageParam?, TData>>) -> PageParam<TPageParam>, getPreviousPageParam: suspend (pages: List<PagedData<TPageParam?, TData>>) -> PageParam<TPageParam>? = null, dispatcher: CoroutineDispatcher = Dispatchers.Default, ttl: Duration? = null, query: suspend (page: TPageParam?) -> TData?)

MutationFactoryWithInput

class MutationFactoryWithInput<TInput : CacheableInput.MutationInput, TData, TError : Throwable>(cache: OnHandCache, dispatcher: CoroutineDispatcher = Dispatchers.Default, mutation: suspend (input: TInput) -> TData)

MutationFactoryWithNoInput

class MutationFactoryWithNoInput<TData, TError : Throwable>(cache: OnHandCache, dispatcher: CoroutineDispatcher = Dispatchers.Default, mutation: suspend () -> TData)

PagedData

data class PagedData<TPageParam, TData>(val page: TPageParam, val data: TData?)

PageParam

sealed class PageParam<out T>

Sealed type for representing the next or previous page param in infinite queries. Use Value to signal that a page is available to fetch, and None to signal that no more pages exist in that direction.

QueryFactoryWithInput

class QueryFactoryWithInput<TInput : CacheableInput.QueryInput, TData, TError : Throwable>(cache: OnHandCache, dispatcher: CoroutineDispatcher = Dispatchers.Default, ttl: Duration? = null, query: suspend (input: TInput) -> TData)

Factory for creating CacheableQueryWithInput instances.

QueryFactoryWithNoInput

class QueryFactoryWithNoInput<TData, TError : Throwable>(cache: OnHandCache, cacheKey: CacheableInput.QueryInput, dispatcher: CoroutineDispatcher = Dispatchers.Default, ttl: Duration? = null, query: suspend () -> TData)

Factory for creating CacheableQueryWithNoInput instances.

Properties

cachedDataState

val <TData, TError : Throwable> CacheableResultWithData<TData, TError>.cachedDataState: CacheAndFetchState

Convenience property to know if your cache already has data. This can be helpful with optimistic updates so that you don't always show a spinner if there is cache information already, but you are doing a fetch operation

Functions

flowFactoryOf

fun <TInput : CacheableInput.FlowInput, TData, TError : Throwable> flowFactoryOf(cache: OnHandCache, dispatcher: CoroutineDispatcher = Dispatchers.Default, ttl: Duration? = null, flow: (input: TInput) -> Flow<TData>): FlowFactoryWithInput<TInput, TData, TError>

fun <TInput : CacheableInput.FlowInput, TData, TError : Throwable> flowFactoryOf(cache: OnHandCache, cacheKey: TInput, dispatcher: CoroutineDispatcher = Dispatchers.Default, ttl: Duration? = null, flow: () -> Flow<TData>): FlowFactoryWithNoInput<TData, TError>

infiniteQueryFactoryOf

fun <TInput : CacheableInput.QueryInput, TPageParam, TData, TError : Throwable> infiniteQueryFactoryOf(cache: OnHandCache, initialPageParam: TPageParam? = null, getNextPageParam: suspend (pages: List<PagedData<TPageParam?, TData>>) -> PageParam<TPageParam>, getPreviousPageParam: suspend (pages: List<PagedData<TPageParam?, TData>>) -> PageParam<TPageParam>? = null, dispatcher: CoroutineDispatcher = Dispatchers.Default, ttl: Duration? = null, query: suspend (input: TInput, page: TPageParam?) -> TData?): InfiniteQueryFactoryWithInput<TInput, TPageParam, TData, TError>

fun <TPageParam, TData, TError : Throwable> infiniteQueryFactoryOf(cache: OnHandCache, cacheKey: CacheableInput.QueryInput, initialPageParam: TPageParam? = null, getNextPageParam: suspend (pages: List<PagedData<TPageParam?, TData>>) -> PageParam<TPageParam>, getPreviousPageParam: suspend (pages: List<PagedData<TPageParam?, TData>>) -> PageParam<TPageParam>? = null, dispatcher: CoroutineDispatcher = Dispatchers.Default, ttl: Duration? = null, query: suspend (page: TPageParam?) -> TData?): InfiniteQueryFactoryWithNoInput<TPageParam, TData, TError>

mutationFactoryOf

fun <TData, TError : Throwable> mutationFactoryOf(cache: OnHandCache, dispatcher: CoroutineDispatcher = Dispatchers.Default, query: suspend () -> TData): MutationFactoryWithNoInput<TData, TError>

fun <TInput : CacheableInput.MutationInput, TData, TError : Throwable> mutationFactoryOf(cache: OnHandCache, dispatcher: CoroutineDispatcher = Dispatchers.Default, query: suspend (input: TInput) -> TData): MutationFactoryWithInput<TInput, TData, TError>

mutationFactoryWithNoOutputOf

fun <TError : Throwable> mutationFactoryWithNoOutputOf(cache: OnHandCache, dispatcher: CoroutineDispatcher = Dispatchers.Default, query: suspend () -> Unit): FireAndForgetMutationFactoryWithNoInput<TError>

fun <TInput : CacheableInput.MutationInput, TError : Throwable> mutationFactoryWithNoOutputOf(cache: OnHandCache, dispatcher: CoroutineDispatcher = Dispatchers.Default, query: suspend (input: TInput) -> Unit): FireAndForgetMutationFactoryWithInput<TInput, TError>

queryFactoryOf

fun <TInput : CacheableInput.QueryInput, TData, TError : Throwable> queryFactoryOf(cache: OnHandCache, dispatcher: CoroutineDispatcher = Dispatchers.Default, ttl: Duration? = null, query: suspend (input: TInput) -> TData): QueryFactoryWithInput<TInput, TData, TError>

Creates a QueryFactoryWithInput.

fun <TInput : CacheableInput.QueryInput, TData, TError : Throwable> queryFactoryOf(cache: OnHandCache, cacheKey: TInput, dispatcher: CoroutineDispatcher = Dispatchers.Default, ttl: Duration? = null, query: suspend () -> TData): QueryFactoryWithNoInput<TData, TError>

Creates a QueryFactoryWithNoInput.