StreamBloc<State, StreamType extends Object?> class abstract

  • Contains implementation for single subscription streams
  • StreamType - the return type of the stream‚

Constructors

StreamBloc(State initial)
  • Contains implementation for single subscription streams
  • StreamType - the return type of the stream

    • Properties

    dataStream → Stream<StreamType>
  • Stream to listen for when the bloc is created
    • no setter
    dataStreamSubscription ↔ StreamSubscription<StreamType>?
  • the stream subscription for the provided dataStream
  • will be initialised when the stream is subscribed
    • getter/setter pair
    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

    Methods

    add(StreamBlocEvent event) → void
    Notifies the Bloc of a new event which triggers all corresponding EventHandler instances. If close has already been called, any subsequent calls to add will be ignored and will not result in any subsequent state changes.
    inherited
    addError(Object error, [StackTrace? stackTrace]) → void
    Reports an error which triggers onError with an optional StackTrace.
    inherited
    close() → Future<void>
    Closes the event and state Streams. This method should be called when a Bloc is no longer needed. Once close is called, events that are added will not be processed. In addition, if close is called while events are still being processed, the Bloc will finish processing the pending events.
    disposeStream() → void
  • called when the bloc is disposed or when notifySourceChanged is called
    • emit(State state) → void
    emit should never be used outside of tests.
    inherited
    initialise() → void
  • must be called for the stream to be listened
    • 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
    mapEventToState(StreamBlocEvent event) → Stream<State>
    @Deprecated - Use on
    inherited
    noSuchMethod(Invocation invocation) → dynamic
    Invoked when a nonexistent method or property is accessed.
    inherited
    notifySourceChanged() → void
  • cancels the stream and resubscribes to the stream to get the new data
    • on<E extends Event>(EventHandler<E, State> handler, {EventTransformer<E>? transformer}) → void
    Register event handler for an event of type E. There should only ever be one event handler per event type E.
    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
    onEvent(StreamBlocEvent event) → void
    Called whenever an event is added to the Bloc. A great spot to add logging/analytics at the individual Bloc level.
    inherited
    onStreamData(StreamType data, Emitter<State> emit) → Future<void>
  • called when ever the stream emits data
    • onStreamError(Object error, StackTrace stackTrace, Emitter<State> emit) → Future<void>
  • called when ever the stream emits error
    • onTransition(Transition<StreamBlocEvent, State> transition) → void
    Called whenever a transition occurs with the given transition. A transition occurs when a new event is added and a new state is emitted from a corresponding EventHandler. executed. onTransition is called before a Bloc's state has been updated. A great spot to add logging/analytics at the individual Bloc level.
    inherited
    toString() → String
    A string representation of this object.
    inherited
    transformEvents(Stream<StreamBlocEvent> events, TransitionFunction<StreamBlocEvent, State> transitionFn) → Stream<Transition<StreamBlocEvent, State>>
    @Deprecated - Use on<Event> with an EventTransformer instead. Will be removed in v8.0.0
    inherited
    transformTransitions(Stream<Transition<StreamBlocEvent, State>> transitions) → Stream<Transition<StreamBlocEvent, State>>
    @Deprecated - Override Stream<State> get stream instead. Will be removed in v8.0.0
    inherited

    Operators

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