Cubit<State> class

A Cubit is a subset of bloc which has no notion of events and relies on methods to emit new states.

Every cubit requires an initial state which will be the state of the cubit before emit has been called.

The current state of a cubit can be accessed via the state getter.

class CounterCubit extends Cubit<int> {
  CounterCubit() : super(0);

  void increment() => emit(state + 1);
}

See also:

Inheritance

Constructors

Cubit(State initialState)
A Cubit is a subset of bloc which has no notion of events and relies on methods to emit new states. [...]

Properties

first Future<State>
The first element of this stream. [...]
read-only, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
isBroadcast bool
Returns whether the Stream<State> is a broadcast stream. Every CubitStream is a broadcast stream.
read-only, inherited
isEmpty Future<bool>
Whether this stream contains any elements. [...]
read-only, inherited
last Future<State>
The last element of this stream. [...]
read-only, inherited
length Future<int>
The number of elements in this stream. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
single Future<State>
The single element of this stream. [...]
read-only, inherited
state → State
The current state.
read-only, inherited

Methods

any(bool test(State element)) Future<bool>
Checks whether test accepts any element provided by this stream. [...]
inherited
asBroadcastStream({void onListen(StreamSubscription<State> subscription), void onCancel(StreamSubscription<State> subscription)}) Stream<State>
Returns a multi-subscription stream that produces the same events as this. [...]
inherited
asyncExpand<E>(Stream<E> convert(State event)) Stream<E>
Transforms each element into a sequence of asynchronous events. [...]
inherited
asyncMap<E>(FutureOr<E> convert(State 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<void>
Closes the CubitStream. When close is called, new states can no longer be emitted. All data on the stream is discarded and a Future is returned which resolves when it is done or an error occurred.
@mustCallSuper, inherited
contains(Object needle) Future<bool>
Returns whether needle occurs in the elements provided by this stream. [...]
inherited
distinct([bool equals(State previous, State next)]) Stream<State>
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<State>
Returns the value of the indexth data event of this stream. [...]
inherited
emit(State state) → void
Updates the state to the provided state. emit does nothing if the CubitStream has been closed or if the state being emitted is equal to the current state.
override
every(bool test(State element)) Future<bool>
Checks whether test accepts all elements provided by this stream. [...]
inherited
expand<S>(Iterable<S> convert(State element)) Stream<S>
Transforms each element of this stream into a sequence of elements. [...]
inherited
firstWhere(bool test(State element), {State orElse()}) Future<State>
Finds the first element of this stream matching test. [...]
inherited
fold<S>(S initialValue, S combine(S previous, State element)) Future<S>
Combines a sequence of values by repeatedly applying combine. [...]
inherited
forEach(void action(State element)) Future
Executes action on each element of this stream. [...]
inherited
handleError(Function onError, {bool test(dynamic error)}) Stream<State>
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(State element), {State orElse()}) Future<State>
Finds the last element in this stream matching test. [...]
inherited
listen(void onData(State), {Function onError, void onDone(), bool cancelOnError}) StreamSubscription<State>
Adds a subscription to the Stream<State>. Returns a StreamSubscription which handles events from the Stream<State> using the provided onData, onError and onDone handlers.
inherited
map<S>(S convert(State event)) Stream<S>
Transforms each element of this stream into a new stream event. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
onTransition(Transition<State> transition) → void
Called whenever a transition occurs with the given transition. A transition occurs when a new state is emitted. onTransition is called before the state of the cubit is updated. onTransition is a great spot to add logging/analytics for a specific cubit. [...]
@mustCallSuper
pipe(StreamConsumer<State> streamConsumer) Future
Pipes the events of this stream into streamConsumer. [...]
inherited
reduce(State combine(State previous, State element)) Future<State>
Combines a sequence of values by repeatedly applying combine. [...]
inherited
singleWhere(bool test(State element), {State orElse()}) Future<State>
Finds the single element in this stream matching test. [...]
inherited
skip(int count) Stream<State>
Skips the first count data events from this stream. [...]
inherited
skipWhile(bool test(State element)) Stream<State>
Skip data events from this stream while they are matched by test. [...]
inherited
take(int count) Stream<State>
Provides at most the first count data events of this stream. [...]
inherited
takeWhile(bool test(State element)) Stream<State>
Forwards data events while test is successful. [...]
inherited
timeout(Duration timeLimit, {void onTimeout(EventSink<State> sink)}) Stream<State>
Creates a new stream with the same events as this stream. [...]
inherited
toList() Future<List<State>>
Collects all elements of this stream in a List. [...]
inherited
toSet() Future<Set<State>>
Collects the data of this stream in a Set. [...]
inherited
toString() String
Returns a string representation of this object.
inherited
transform<S>(StreamTransformer<State, S> streamTransformer) Stream<S>
Applies streamTransformer to this stream. [...]
inherited
where(bool test(State event)) Stream<State>
Creates a new stream from this stream that discards some elements. [...]
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited

Static Properties

observer CubitObserver
The current CubitObserver.
read / write