EventsCollection class

A base class for a collection of Event instances that are all tied to the same DispatchKey.

Use this class to colocate related Event instances and to make disposal of these Events easier.

final key = new DispatchKey('example');

class ExampleEvents extends EventsCollection {
  final Event<String> eventA = new Event<String>(key);
  final Event<String> eventB = new Event<String>(key);

  ExampleEvents() : super(key) {
    [
      eventA,
      eventB,
    ].forEach(manageEvent);
  }
}

Constructors

EventsCollection(DispatchKey key)

Properties

didDispose → Future<Null>
A Future that will complete when this object has been disposed.
no setterinherited
disposableTypeName → String
A type name, similar to runtimeType but intended to work with minified code.
no setter
disposalTreeSize → int
The total size of the disposal tree rooted at the current Disposable instance.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
isDisposed → bool
Whether this object has been disposed.
no setterinherited
isLeakFlagSet → bool
Whether the leak flag for this object has been set.
no setterinherited
isOrWillBeDisposed → bool
Whether the disposal of this object has been requested, is in progress, or is complete.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

awaitBeforeDispose<T>(Future<T> future) → Future<T>
Add future to a list of futures that will be awaited before the object is disposed.
inherited
dispose() → Future<Null>
Dispose of the object, cleaning up to prevent memory leaks.
inherited
flagLeak([String? description]) → void
Flag the object as having been disposed in a way that allows easier profiling.
inherited
getManagedDelayedFuture<T>(Duration duration, T callback()) → Future<T>
Creates a Future that will complete, with the value returned by callback, after the given amount of time has elapsed.
inherited
getManagedDisposer(Disposer disposer) → ManagedDisposer
Automatically handle arbitrary disposals using a callback.
inherited
getManagedPeriodicTimer(Duration duration, void callback(Timer timer)) → Timer
Creates a periodic Timer that will be cancelled if active upon disposal.
inherited
getManagedTimer(Duration duration, void callback()) → Timer
Creates a Timer instance that will be cancelled if active upon disposal.
inherited
listenToStream<T>(Stream<T> stream, void onData(T event), {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription<T>
Returns a StreamSubscription which handles events from the stream using the provided onData, onError and onDone handlers.
inherited
manageAndReturnTypedDisposable<T extends Disposable>(T disposable) → T
Automatically dispose another object when this object is disposed.
inherited
manageCompleter<T>(Completer<T> completer) → Completer<T>
Ensure that a completer is completed when the object is disposed.
inherited
manageDisposable(Disposable disposable) → void
inherited
manageEvent(Event event) → void
Registers an Event to be closed when this EventsCollection is disposed.
manageStreamController(StreamController controller) → void
Automatically cancel a stream controller when this object is disposed.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onDispose() → Future<Null>
Callback to allow arbitrary cleanup on dispose.
inherited
onWillDispose() → Future<Null>
Callback to allow arbitrary cleanup as soon as disposal is requested (i.e. dispose is called) but prior to disposal actually starting.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited