Cubit<State> class abstract

A Cubit is similar to Bloc but 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);
}

Inheritance

Constructors

Cubit(State initialState): A Cubit is similar to Bloc but has no notion of events and relies on methods to emit new states.

hashCode → int: The hash code for this object.
no setterinherited
isClosed → bool: Whether the bloc is closed.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
state → State: The current state.
no setterinherited
stream → Stream<State>: The current state stream.
no setterinherited

addError(Object error, [StackTrace? stackTrace]) → void: Reports an error which triggers onError with an optional StackTrace.
inherited
close() → Future<void>: Closes the instance. This method should be called when the instance is no longer needed. Once close is called, the instance can no longer be used.
inherited
emit(State state) → void: Updates the state to the provided state. emit does nothing if the instance has been closed or if the state being emitted is equal to the current state.
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
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
onChange(Change<State> change) → void: Called whenever a change occurs with the given change. A change occurs when a new state is emitted. onChange is called before the state of the cubit is updated. onChange is a great spot to add logging/analytics for a specific cubit.
inherited
onError(Object error, StackTrace stackTrace) → void: Called whenever an error occurs and notifies BlocObserver.onError.
inherited
toString() → String: A string representation of this object.
inherited