Ref¶

interface Ref<Failure, Value>

A reference to a specific object.

A reference is a small object that allows to pass around an object from an API without querying it. A reference should always be immutable. Each reference has a matching Backbone object responsible for managing it.

Ref implementation should ensure that their equals and hashCode functions are correct.

To access the value behind a reference, use request.

Note for implementors¶

When implementing this interface, it is common to provide functions to all mutating methods from the matching Backbone as wrappers to it. This makes using the reference easier.

Type Parameters¶

Value: The object this reference refers to.
Failure: Failures that may be returned when calling request.

Types¶

`Companion`¶

object Companion

Functions¶

now¶

suspend fun <Failure, Value> Ref<Failure, Value>.now(): Outcome<Failure, Value>

Requests the referenced data, returning the first value returned by the cache.

This function returns a single value and not a subscription, it is not recommended to use it when being notified of new values is important (e.g. in a UI), in which case you should use Ref.request. This function is intended for non-reactive environments (e.g. server requests, tests…).

request¶

abstract fun request(): ProgressiveFlow<Failure, Value>

Requests the referenced data.

It is encouraged, but not mandatory, to implement this method using Cache.