Ribs

Appearance

ribs_rill›Classes›SignallingRef<A>

SignallingRef<A> abstract ​

abstractclassSignallingRef<A>implementsRef<A>,Signal<A>

A mutable, observable reference — a Ref that also acts as a Signal.

Writes via Ref methods (e.g. setValue, update) immediately notify all discrete subscribers. continuous polls the current value without waiting.

Implemented types

Available Extensions

Constructors ​

SignallingRef() ​

SignallingRef()

Properties ​

continuous no setter inherited ​

Rill<A>getcontinuous

Emits the current value repeatedly, regardless of whether it changed.

Inherited from Signal.

Implementation
dart
Rill<A> get continuous;

discrete no setter inherited ​

Rill<A>getdiscrete

Emits the current value, then emits only when the value changes. Note: If the source updates faster than the consumer reads, intermediate updates are dropped. It guarantees you always get the latest value.

Inherited from Signal.

Implementation
dart
Rill<A> get discrete;

hashCode no setter inherited ​

intgethashCode

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Inherited from Object.

Implementation
dart
external int get hashCode;

runtimeType no setter inherited ​

TypegetruntimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation
dart
external Type get runtimeType;

Methods ​

access() inherited ​

IO<Record>access()

Obtains a snapshot of the current value, and a setter for updating it.

The setter attempts to modify the contents from the snapshot to the new value (and return true). If it cannot do this (because the contents changed since taking the snapshot), the setter is a noop and returns false.

Inherited from Ref.

Implementation
dart
IO<(A, Function1<A, IO<bool>>)> access();

changes() inherited ​

Signal<A>changes({boolFunction(A,A)?eq})

Returns a derived Signal that skips consecutive equal values.

Uses == by default; supply eq for a custom equality check.

Inherited from Signal.

Implementation
dart
Signal<A> changes({Function2<A, A, bool>? eq}) => _ChangesSignal(this, eq ?? (a, b) => a == b);

flatModify() inherited ​

IO<B>flatModify<B>(RecordFunction(A)f)

Like modify, but also schedules the resulting effect right after modification. The modification and finalizer are both within an uncancelable region to prevent out-of-sync issues.

See flatModifyFull to create a finalizer that can potentially be canceled.

Inherited from Ref.

Implementation
dart
IO<B> flatModify<B>(Function1<A, (A, IO<B>)> f) => IO.uncancelable((_) => modify(f).flatten());

flatModifyFull() inherited ​

IO<B>flatModifyFull<B>(RecordFunction(Record)f)

Like flatModify, but the modification function also receives a Poll so the resulting effect can have cancelable regions within the uncancelable block.

Inherited from Ref.

Implementation
dart
IO<B> flatModifyFull<B>(Function1<(Poll, A), (A, IO<B>)> f) =>
    IO.uncancelable((poll) => modify((a) => f((poll, a))).flatten());

getAndDiscreteUpdates() inherited ​

Resource<Record>getAndDiscreteUpdates()

Returns the current value paired with a Rill of future changes.

The returned Resource ensures that the subscription is active before the caller reads the current value, preventing missed updates.

Inherited from Signal.

Implementation
dart
Resource<(A, Rill<A>)> getAndDiscreteUpdates() =>
    discrete.pull.uncons1.flatMap(Pull.outputOption1).rillNoScope.compile.resource.onlyOrError;

getAndSet() inherited ​

IO<A>getAndSet(Aa)

Sets the value of this ref to a and returns the previous value.

Inherited from Ref.

Implementation
dart
IO<A> getAndSet(A a) => getAndUpdate((_) => a);

getAndUpdate() inherited ​

IO<A>getAndUpdate(AFunction(A)f)

Updates the value of this ref using f and returns the previous value.

Inherited from Ref.

Implementation
dart
IO<A> getAndUpdate(Function1<A, A> f) => modify((a) => (f(a), a));

modify() inherited ​

IO<B>modify<B>(RecordFunction(A)f)

Modifies the value of this ref according to f and returns the new value.

Inherited from Ref.

Implementation
dart
IO<B> modify<B>(Function1<A, (A, B)> f);

noSuchMethod() inherited ​

dynamicnoSuchMethod(Invocationinvocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dart
dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

dart
class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

Implementation
dart
@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

setValue() inherited ​

IO<Unit>setValue(Aa)

Sets the value of this ref to a.

Inherited from Ref.

Implementation
dart
IO<Unit> setValue(A a);

toString() inherited ​

StringtoString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Object.

Implementation
dart
external String toString();

tryModify() inherited ​

IO<Option<B>>tryModify<B>(RecordFunction(A)f)

Attempts to modify the value of this ref according to f. If the modification succeeds, the new value is returned as a Some. If it fails, None is returned.

Inherited from Ref.

Implementation
dart
IO<Option<B>> tryModify<B>(Function1<A, (A, B)> f);

tryUpdate() inherited ​

IO<bool>tryUpdate(AFunction(A)f)

Attempts to update the value of this ref according to f. If the update succeeds, true is returned, otherwise false is returned.

Inherited from Ref.

Implementation
dart
IO<bool> tryUpdate(Function1<A, A> f) => tryModify((a) => (f(a), Unit())).map((a) => a.isDefined);

update() inherited ​

IO<Unit>update(AFunction(A)f)

Updates the value of this ref by applying f to the current value.

Inherited from Ref.

Implementation
dart
IO<Unit> update(Function1<A, A> f);

updateAndGet() inherited ​

IO<A>updateAndGet(AFunction(A)f)

Updates the value of this ref by applying f to the current value and returns the new value.

Inherited from Ref.

Implementation
dart
IO<A> updateAndGet(Function1<A, A> f) => modify((a) {
  final newA = f(a);
  return (newA, newA);
});

value() inherited ​

IO<A>value()

Returns the current value of this ref.

Inherited from Ref.

Implementation
dart
IO<A> value();

waitUntil() inherited ​

IO<Unit>waitUntil(boolFunction(A)p)

Blocks until the signal's value satisfies p.

Inherited from Signal.

Implementation
dart
IO<Unit> waitUntil(Function1<A, bool> p) => discrete.forall((a) => !p(a)).compile.drain;

Extension Methods ​

map() extension ​

Signal<B>map<B>(BFunction(A)f)

Returns a derived Signal whose value is f applied to this signal's value.

Available on Signal<A>, provided by the SignalMapOps<A> extension

Implementation
dart
Signal<B> map<B>(Function1<A, B> f) => _MappedSignal(this, f);

Operators ​

operator ==() inherited ​

booloperator ==(Objectother)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

  • Total: It must return a boolean for all arguments. It should never throw.

  • Reflexive: For all objects o, o == o must be true.

  • Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

  • Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Object.

Implementation
dart
external bool operator ==(Object other);

Static Methods ​

of() override ​

IO<SignallingRef<A>>of<A>(Ainitial)

Creates a SignallingRef with the given initial value.

Implementation
dart
static IO<SignallingRef<A>> of<A>(A initial) => Ref.of(
  _State<A>(initial, 0, imap({})),
).product(Ref.of(1)).mapN((state, ids) => _SignallingRefImpl(state, ids));