Subject<T> class abstract

The base for all Subjects. If you'd like to create a new Subject, extend from this class.

It handles all of the nitty-gritty details that conform to the StreamController spec and don't need to be repeated over and over.

Please see PublishSubject for the simplest example of how to extend from this class, or BehaviorSubject for a slightly more complex example.

Inheritance
Implemented types
Implementers
Available extensions

Constructors

Subject(StreamController<T> controller, Stream<T> stream)
Constructs a Subject which wraps the provided controller. This constructor is applicable only for classes that extend Subject.

Properties

done → Future
A future which is completed when the stream controller is done sending events.
no setteroverride
first → Future<T>
The first element of this stream.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
hasListener → bool
Whether there is a subscriber on the Stream.
no setteroverride
isBroadcast → bool
Whether this stream is a broadcast stream.
no setterinherited
isClosed → bool
Whether the stream controller is closed for adding more events.
no setteroverride
isEmpty → Future<bool>
Whether this stream contains any elements.
no setterinherited
isPaused → bool
Whether the subscription would need to buffer events.
no setteroverride
last → Future<T>
The last element of this stream.
no setterinherited
length → Future<int>
The number of elements in this stream.
no setterinherited
onCancel ↔ ControllerCancelCallback?
The callback which is called when the stream is canceled.
getter/setter pairoverride
onListen ↔ ControllerCallback?
The callback which is called when the stream is listened to.
getter/setter pairoverride
onPause ↔ ControllerCallback
The callback which is called when the stream is paused.
getter/setter pairoverride
onResume ↔ ControllerCallback
The callback which is called when the stream is resumed.
getter/setter pairoverride
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
single → Future<T>
The single element of this stream.
no setterinherited
sink → StreamSink<T>
Returns a view of this object that only exposes the StreamSink interface.
no setteroverride
stream → Stream<T>
The stream that this controller is controlling.
no setteroverride

Methods

add(T event) → void
Sends a data event.
override
addError(Object error, [StackTrace? stackTrace]) → void
Sends or enqueues an error event.
override
addStream(Stream<T> source, {bool? cancelOnError}) → Future<void>
Receives events from source and puts them into this controller's stream.
override
any(bool test(T element)) → Future<bool>
Checks whether test accepts any element provided by this stream.
inherited
asBroadcastStream({void onListen(StreamSubscription<T> subscription)?, void onCancel(StreamSubscription<T> subscription)?}) → Stream<T>
Returns a multi-subscription stream that produces the same events as this.
inherited
asyncExpand<E>(Stream<E>? convert(T event)) → Stream<E>
Transforms each element into a sequence of asynchronous events.
inherited
asyncMap<E>(FutureOr<E> convert(T event)) → Stream<E>
Creates a new stream with each data event of this stream asynchronously mapped to a new event.
inherited
cast<R>() → Stream<R>
Adapt this stream to be a Stream<R>.
inherited
close() → Future
Closes the stream.
override
contains(Object? needle) → Future<bool>
Returns whether needle occurs in the elements provided by this stream.
inherited
createForwardingSubject<R>({void onListen()?, void onCancel()?, bool sync = false}) → Subject<R>
Creates a trampoline StreamController, which can forward events in the same manner as the original Subject does. e.g. replay or behavior on subscribe.
debounce(Stream window(T event)) → Stream<T>

Available on Stream<T>, provided by the DebounceExtensions extension

Transforms a Stream so that will only emit items from the source sequence if a window has completed, without the source sequence emitting another item.
debounceTime(Duration duration) → Stream<T>

Available on Stream<T>, provided by the DebounceExtensions extension

Transforms a Stream so that will only emit items from the source sequence whenever the time span defined by duration passes, without the source sequence emitting another item.
distinct([bool equals(T previous, T next)?]) → Stream<T>
Skips data events if they are equal to the previous data event.
inherited
drain<E>([E? futureValue]) → Future<E>
Discards all data on this stream, but signals when it is done or an error occurred.
inherited
elementAt(int index) → Future<T>
Returns the value of the indexth data event of this stream.
inherited
every(bool test(T element)) → Future<bool>
Checks whether test accepts all elements provided by this stream.
inherited
expand<S>(Iterable<S> convert(T element)) → Stream<S>
Transforms each element of this stream into a sequence of elements.
inherited
firstWhere(bool test(T element), {T orElse()?}) → Future<T>
Finds the first element of this stream matching test.
inherited
fold<S>(S initialValue, S combine(S previous, T element)) → Future<S>
Combines a sequence of values by repeatedly applying combine.
inherited
forEach(void action(T element)) → Future<void>
Executes action on each element of this stream.
inherited
handleError(Function onError, {bool test(dynamic error)?}) → Stream<T>
Creates a wrapper Stream that intercepts some errors from this stream.
inherited
join([String separator = ""]) → Future<String>
Combines the string representation of elements into a single string.
inherited
lastWhere(bool test(T element), {T orElse()?}) → Future<T>
Finds the last element in this stream matching test.
inherited
listen(void onData(T value)?, {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription<T>
Adds a subscription to this stream.
inherited
map<S>(S convert(T event)) → Stream<S>
Transforms each element of this stream into a new stream event.
inherited
mergeWith(Iterable<Stream<T>> streams) → Stream<T>

Available on Stream<T>, provided by the MergeExtension extension

Combines the items emitted by multiple streams into a single stream of items. The items are emitted in the order they are emitted by their sources.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onAdd(T event) → void
An extension point for sub-classes. Perform any side-effect / state management you need to here, rather than overriding the add method directly.
onAddError(Object error, [StackTrace? stackTrace]) → void
An extension point for sub-classes. Perform any side-effect / state management you need to here, rather than overriding the add method directly.
pipe(StreamConsumer<T> streamConsumer) → Future
Pipes the events of this stream into streamConsumer.
inherited
reduce(T combine(T previous, T element)) → Future<T>
Combines a sequence of values by repeatedly applying combine.
inherited
singleWhere(bool test(T element), {T orElse()?}) → Future<T>
Finds the single element in this stream matching test.
inherited
skip(int count) → Stream<T>
Skips the first count data events from this stream.
inherited
skipWhile(bool test(T element)) → Stream<T>
Skip data events from this stream while they are matched by test.
inherited
startWith(T startValue) → Stream<T>

Available on Stream<T>, provided by the StartWithExtension extension

Prepends a value to the source Stream.
switchMap<S>(Stream<S> mapper(T value)) → Stream<S>

Available on Stream<T>, provided by the SwitchMapExtension extension

Converts each emitted item into a Stream using the given mapper function. The newly created Stream will be be listened to and begin emitting items, and any previously created Stream will stop emitting.
take(int count) → Stream<T>
Provides at most the first count data events of this stream.
inherited
takeWhile(bool test(T element)) → Stream<T>
Forwards data events while test is successful.
inherited
timeout(Duration timeLimit, {void onTimeout(EventSink<T> sink)?}) → Stream<T>
Creates a new stream with the same events as this stream.
inherited
toList() → Future<List<T>>
Collects all elements of this stream in a List.
inherited
toSet() → Future<Set<T>>
Collects the data of this stream in a Set.
inherited
toString() → String
A string representation of this object.
inherited
transform<S>(StreamTransformer<T, S> streamTransformer) → Stream<S>
Applies streamTransformer to this stream.
inherited
where(bool test(T event)) → Stream<T>
Creates a new stream from this stream that discards some elements.
inherited

Operators

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