Throttling<T> class
final
Throttling Have method throttle
- Inheritance
-
- Object
- Stream<
ThrottlingStatus> - Throttling
- Implemented types
-
- Sink<
T Function()>
- Sink<
Constructors
- Throttling({Duration duration = const Duration(seconds: 1)})
- Throttling Have method throttle Must be closed with close method
Properties
- duration ↔ Duration
-
Get current duration
getter/setter pair
-
first
→ Future<
ThrottlingStatus> -
The first element of this stream.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- isBroadcast → bool
-
Whether this stream is a broadcast stream.
no setterinherited
- isBusy → bool
-
Waiting for the end of the pause
no setter
-
isEmpty
→ Future<
bool> -
Whether this stream contains any elements.
no setterinherited
- isIdle → bool
-
Is ready to accept new events
no setter
-
last
→ Future<
ThrottlingStatus> -
The last element of this stream.
no setterinherited
-
length
→ Future<
int> -
The number of elements in this stream.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
single
→ Future<
ThrottlingStatus> -
The single element of this stream.
no setterinherited
Methods
-
add(
T data()) → T? -
Shortcut for throttle method
override
-
any(
bool test(ThrottlingStatus element)) → Future< bool> -
Checks whether
test
accepts any element provided by this stream.inherited -
asBroadcastStream(
{void onListen(StreamSubscription< ThrottlingStatus> subscription)?, void onCancel(StreamSubscription<ThrottlingStatus> subscription)?}) → Stream<ThrottlingStatus> -
Returns a multi-subscription stream that produces the same events as this.
inherited
-
asyncExpand<
E> (Stream< E> ? convert(ThrottlingStatus event)) → Stream<E> -
Transforms each element into a sequence of asynchronous events.
inherited
-
asyncMap<
E> (FutureOr< E> convert(ThrottlingStatus 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(
) → void -
Closes the sink.
override
-
contains(
Object? needle) → Future< bool> -
Returns whether
needle
occurs in the elements provided by this stream.inherited -
distinct(
[bool equals(ThrottlingStatus previous, ThrottlingStatus next)?]) → Stream< ThrottlingStatus> -
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< ThrottlingStatus> -
Returns the value of the
index
th data event of this stream.inherited -
every(
bool test(ThrottlingStatus element)) → Future< bool> -
Checks whether
test
accepts all elements provided by this stream.inherited -
expand<
S> (Iterable< S> convert(ThrottlingStatus element)) → Stream<S> -
Transforms each element of this stream into a sequence of elements.
inherited
-
firstWhere(
bool test(ThrottlingStatus element), {ThrottlingStatus orElse()?}) → Future< ThrottlingStatus> -
Finds the first element of this stream matching
test
.inherited -
fold<
S> (S initialValue, S combine(S previous, ThrottlingStatus element)) → Future< S> -
Combines a sequence of values by repeatedly applying
combine
.inherited -
forEach(
void action(ThrottlingStatus element)) → Future< void> -
Executes
action
on each element of this stream.inherited -
handleError(
Function onError, {bool test(dynamic error)?}) → Stream< ThrottlingStatus> -
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(ThrottlingStatus element), {ThrottlingStatus orElse()?}) → Future< ThrottlingStatus> -
Finds the last element in this stream matching
test
.inherited -
listen(
void onData(ThrottlingStatus status)?, {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription< ThrottlingStatus> -
Adds a subscription to this stream.
override
-
map<
S> (S convert(ThrottlingStatus event)) → Stream< S> -
Transforms each element of this stream into a new stream event.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pipe(
StreamConsumer< ThrottlingStatus> streamConsumer) → Future -
Pipes the events of this stream into
streamConsumer
.inherited -
reduce(
ThrottlingStatus combine(ThrottlingStatus previous, ThrottlingStatus element)) → Future< ThrottlingStatus> -
Combines a sequence of values by repeatedly applying
combine
.inherited -
singleWhere(
bool test(ThrottlingStatus element), {ThrottlingStatus orElse()?}) → Future< ThrottlingStatus> -
Finds the single element in this stream matching
test
.inherited -
skip(
int count) → Stream< ThrottlingStatus> -
Skips the first
count
data events from this stream.inherited -
skipWhile(
bool test(ThrottlingStatus element)) → Stream< ThrottlingStatus> -
Skip data events from this stream while they are matched by
test
.inherited -
take(
int count) → Stream< ThrottlingStatus> -
Provides at most the first
count
data events of this stream.inherited -
takeWhile(
bool test(ThrottlingStatus element)) → Stream< ThrottlingStatus> -
Forwards data events while
test
is successful.inherited -
throttle(
T func()) → T? - Limits the maximum number of times a given event handler can be called over time.
-
timeout(
Duration timeLimit, {void onTimeout(EventSink< ThrottlingStatus> sink)?}) → Stream<ThrottlingStatus> -
Creates a new stream with the same events as this stream.
inherited
-
toList(
) → Future< List< ThrottlingStatus> > -
Collects all elements of this stream in a
List
.inherited -
toSet(
) → Future< Set< ThrottlingStatus> > -
Collects the data of this stream in a
Set
.inherited -
toString(
) → String -
A string representation of this object.
inherited
-
transform<
S> (StreamTransformer< ThrottlingStatus, S> streamTransformer) → Stream<S> -
Applies
streamTransformer
to this stream.inherited -
where(
bool test(ThrottlingStatus event)) → Stream< ThrottlingStatus> -
Creates a new stream from this stream that discards some elements.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited