Package-level declarations

Similar to SharedFlow, but completion and error events are also propagated to the downstream subscribers.

A cache of flows which each follow the behaviour of shareInCompleting - i.e. they share a single upstream and pass completion and errors on to the downstream.

Exposes the current state and future mutations to specific keys (via valueFlow), or the map as a whole (via asFlow).

An event emitted by MapFlow.asFlowWithState.

Alternate version of CompletingSharedFlowCache that uses a single supplier, defined up front, for all calls to get.

Events representing a mutation to a Map.

CompletingSharedFlow equivalent of MutableSharedFlow, providing emit and complete functionality.

Modifiable version of FlowMap

Events representing a mutation to a Set.

A cache of SharedFlows keyed by K, sharing a single upstream collection per key across that key's subscribers. Create one with sharedFlowCache, or completingSharedFlowCache for completion/error propagation.

Events representing a mutation to a Map.

Represents a materialized Flow event.

A map mutation carrying the version it was written at, for distribution to consumers that gate on version >. Unlike MapEvent there is no old value and no Populated marker: the stream is delta-only and current values are read from the store.

Buffers all elements emitted until there is a period of no emissions greater than timeout, then emits all buffered elements within a List.

Buffers all elements emitted until there is a period of no emissions greater than timeoutMillis, then emits all buffered elements within a List.

Casts the elements of the current Flow to the specified type R. The elements that cannot be cast to R will cause a ClassCastException.

Creates a CompletingSharedFlowCache backed by a SharedFlowCache: each supplier's terminal completion/error is materialised into the shared stream and rematerialised per subscriber, so - unlike a plain SharedFlow - completion and errors propagate downstream. The entry is evicted as the terminal is published, so a downstream retry re-resolves to a fresh entry (re-running the supplier) rather than re-reading the terminal.

Conflates each key in the map individually. This buffers emissions, but due to conflation, the maximum number of queued emissions is equal to the number of keys in the map.

Dematerializes ValueOrCompletions back into their counterpart Flow events.

Specialised version of dematerialize which expects unboxed updates. Type information is lost with materializeUnboxed, so must know what type to cast updates to.

Demultiplexes the elements of the flow based on a key selector function. Each element in the flow is assigned a key based on the result of the key selector function. Elements with the same key are grouped together and then processed by the flow producer function.

Subscribes to the upstream and when it receives the first element calls block and then emits the returned Flow

Applies the given suspend lambda function to the first emitted value of the original flow and the entire original flow, producing a new flow of type R.

Converts this CompletingSharedFlowCache to a LoadingCompletingSharedFlowCache.

Materialize Flow events into ValueOrCompletions that can be sent over the wire, for example.

Specialised version of materialize which does not box updates. Loses type information so corresponding dematerializeUnboxed must know what type to cast updates to.

Create a new, empty, MutableFlowMap.

Create a new MutableFlowMap, with the specified contents.

On an error, Retry on the upstream with an exponential delay between each attempt. Behaviour can be modified by proving onRetry - if a call to this returns false it will stop retrying and propagate the error downstream.

Folds a flow of FlowMapStreamEvents into a flow of Map.

Folds a flow of EntryEvents into a flow of Map.

Folds a flow of EntryEvents into a flow of Map.

Folds a flow of MapEvents into a flow of Map.

This method takes a flow of SetEvent and transforms it into a flow of Set. It uses a running fold operation to maintain the state of the set and emit the updated set whenever a relevant event is received.

Creates a SharedFlowCache - a keyed cache of plain SharedFlows, one shared upstream per key, each evicted once its upstream ends (see SharedFlowCache).

Similar to shareIn, but completions and errors are also propagated to the downstream subscribers.

Throttles the emission of values so that they are at least timeMillis apart. Drops the older value(s) if two or more values are emitted within the time period. The first element is emitted immediately.

If the upstream emits no first event within duration it will emit an TimeoutException error.

If the upstream emits no first event within millis milliseconds it will emit an TimeoutException error.

If the upstream emits no first event within duration it will emit the event default followed by all later emissions from the upstream.

If the upstream emits no first event within duration it will emit the event returned by default followed by all later emissions from the upstream.

If the upstream emits no first event within millis milliseconds it will emit the event default followed by all later emissions from the upstream.

If the upstream emits no first event within millis milliseconds it will emit the event returned by default followed by all later emissions from the upstream.

If the upstream emits no first event within duration it will emit null followed by all later emissions from the upstream.

If the upstream emits no first event within millis milliseconds it will emit null followed by all later emissions from the upstream.

Converts a Flow of Set to a stream of events representing the changes between consecutive sets.

Creates a copy of the provided map as a new MutableFlowMap.