yafrl-core/io.github.yafrl/BroadcastEvent

BroadcastEvent

open class BroadcastEvent<A>(node: Node<EventState<A>>) : Event<A> (source)

A BroadcastEvent is an Event that can have new values emitted to it.

Usually used as an internal API to build up a new Event.

Created with the externalEvent function.

Constructors

BroadcastEvent

constructor(node: Node<EventState<A>>)

Properties

node

val node: Node<EventState<A>>

Functions

asSignal

fun asSignal(): Signal<EventState<A>>

collect

suspend fun collect(collector: FlowCollector<A>)

debounced

fun <A> Event<A>.debounced(window: Duration): Event<A>

Blocks occurrence of events until the window of time has passed, after which the latest event will be emitted.

filter

fun filter(f: (A) -> Boolean): Event<A>

Applies the supplied function to each element of the Event, and produces an event that only emits if the function evaluates to true.

gate

fun gate(condition: Behavior<Boolean>): Event<A>

Returns an Event that only fires if the condition does not hold at a particular time.

hold

fun hold(initial: A): Signal<A>

Method version of Signal.hold.

impulse

inline fun <A> Event<A>.impulse(zero: @UnsafeVariance A): Behavior<A>

Builds a dirac impulse whose value is equal to the event values when the even has fired, and whole value is equal to zero otherwise

inline fun <A, B> Event<A>.impulse(zero: B, value: B): Behavior

Builds a dirac impulse whose value is equal to value whenever the event fires, and zero otherwise.

map

fun map(f: SampleScope.(A) -> B): Event

Applies the passed function f to each event that is emitted, producing a new transformed Event stream.

mapNotNull

fun mapNotNull(f: (A) -> B?): Event

scan

fun scan(initial: B, reducer: SampleScope.(B, A) -> B): Signal

Method version of Signal.fold, for easier use in method chains.

send

fun send(value: A)

throttled

fun <A> Event<A>.throttled(duration: Duration): Event<A>

Creates a modified Event that emits events at a frequency of at most duration.

window

fun window(size: Int): Event<List<A>>

Takes and event, and constructs a moving window of size when events occur.