riverbloc library
Riverbloc exposes providers for Bloc and Cubit instances bases in
riverpod
package instead of provider
package.
Providers:
Classes
-
AlwaysAliveRefreshable<
T> -
An interface for provider expressions that can be passed to
ref.refresh
-
AsyncData<
T> - Creates an AsyncValue with a data.
-
AsyncError<
T> - Creates an AsyncValue in the error state.
-
AsyncLoading<
T> - Creates an AsyncValue in loading state.
-
AsyncNotifier<
State> - A Notifier implementation that is asynchronously initialized.
-
AsyncNotifierProviderElement<
NotifierT extends AsyncNotifierBase< T> , T> - The element of AsyncNotifierProvider.
-
AsyncNotifierProviderElementBase<
NotifierT extends AsyncNotifierBase< T> , T> - The element of AsyncNotifierProvider.
-
AsyncNotifierProviderFamily<
NotifierT extends FamilyAsyncNotifier< T, Arg> , T, Arg> - The Family of AsyncNotifierProvider.
-
AsyncNotifierProviderRef<
T> - An object used by providers to interact with other providers and the life-cycles of the application.
-
AsyncValue<
T> - A utility for safely manipulating asynchronous data.
-
AutoDisposeAsyncNotifier<
State> - A provider which creates and listen to an AsyncNotifier.
-
AutoDisposeAsyncNotifierProviderElement<
NotifierT extends AsyncNotifierBase< T> , T> - The element of AutoDisposeAsyncNotifierProvider.
-
AutoDisposeAsyncNotifierProviderFamily<
NotifierT extends AutoDisposeFamilyAsyncNotifier< T, Arg> , T, Arg> - The Family of AsyncNotifierProvider.
-
AutoDisposeAsyncNotifierProviderRef<
T> - An object used by providers to interact with other providers and the life-cycles of the application.
-
AutoDisposeBlocProvider<
B extends BlocBase< S> , S> - Auto Dispose
- AutoDisposeBlocProviderBuilder
- Builds a AutoDisposeBlocProvider.
-
AutoDisposeBlocProviderElement<
B extends BlocBase< S> , S> - The element of AutoDisposeBlocProvider.
-
AutoDisposeBlocProviderFamily<
B extends BlocBase< S> , S, Arg> - A class that allows building a AutoDisposeBlocProvider from an external parameter.
- AutoDisposeBlocProviderFamilyBuilder
- The Family of AutoDisposeBlocProvider.
-
AutoDisposeBlocProviderRef<
B extends BlocBase< S> , S> -
AutoDisposeFamilyAsyncNotifier<
State, Arg> - A provider which creates and listen to an AsyncNotifier.
-
AutoDisposeFamilyNotifier<
State, Arg> - A class which exposes a state that can change over time.
-
AutoDisposeFamilyStreamNotifier<
State, Arg> - A variant of AsyncNotifier which has build creating a Stream.
-
AutoDisposeFutureProvider<
T> - A provider that asynchronously creates a value.
-
AutoDisposeFutureProviderElement<
T> - The ProviderElementBase of AutoDisposeFutureProvider
-
AutoDisposeFutureProviderFamily<
R, Arg> - The Family of an AutoDisposeFutureProvider
-
AutoDisposeFutureProviderRef<
State> - An object used by providers to interact with other providers and the life-cycles of the application.
-
AutoDisposeNotifier<
State> - A class which exposes a state that can change over time.
-
AutoDisposeNotifierProviderElement<
NotifierT extends NotifierBase< T> , T> - The element of AutoDisposeNotifierProvider
-
AutoDisposeNotifierProviderFamily<
NotifierT extends AutoDisposeFamilyNotifier< T, Arg> , T, Arg> - The Family of NotifierProvider.
-
AutoDisposeNotifierProviderRef<
T> - An object used by providers to interact with other providers and the life-cycles of the application.
-
AutoDisposeProvider<
T> - A provider that exposes a read-only value.
-
AutoDisposeProviderElement<
T> - The element of AutoDisposeProvider
-
AutoDisposeProviderFamily<
R, Arg> - The Family of AutoDisposeProvider
-
AutoDisposeProviderRef<
State> - An object used by providers to interact with other providers and the life-cycles of the application.
-
AutoDisposeRef<
State> - A Ref for providers that are automatically destroyed when no longer used.
-
AutoDisposeStateNotifierProvider<
NotifierT extends StateNotifier< T> , T> - Creates a StateNotifier and exposes its current state.
-
AutoDisposeStateNotifierProviderElement<
NotifierT extends StateNotifier< T> , T> - The element of AutoDisposeStateNotifierProvider.
-
AutoDisposeStateNotifierProviderFamily<
NotifierT extends StateNotifier< T> , T, Arg> - The Family of AutoDisposeStateNotifierProvider.
-
AutoDisposeStateNotifierProviderRef<
NotifierT extends StateNotifier< T> , T> - An object used by providers to interact with other providers and the life-cycles of the application.
-
AutoDisposeStateProvider<
T> - A provider that exposes a value that can be modified from outside.
-
AutoDisposeStateProviderElement<
T> - The element of StateProvider.
-
AutoDisposeStateProviderFamily<
R, Arg> - The Family of StateProvider.
-
AutoDisposeStateProviderRef<
State> - An object used by providers to interact with other providers and the life-cycles of the application.
-
AutoDisposeStreamNotifier<
State> - A variant of AsyncNotifier which has build creating a Stream.
-
AutoDisposeStreamNotifierProviderElement<
NotifierT extends AsyncNotifierBase< T> , T> - The element of AutoDisposeStreamNotifierProvider.
-
AutoDisposeStreamNotifierProviderFamily<
NotifierT extends AutoDisposeFamilyStreamNotifier< T, Arg> , T, Arg> - The Family of StreamNotifierProvider.
-
AutoDisposeStreamNotifierProviderRef<
T> - An object used by providers to interact with other providers and the life-cycles of the application.
-
AutoDisposeStreamProvider<
T> - Creates a stream and exposes its latest event.
-
AutoDisposeStreamProviderElement<
T> - The element of AutoDisposeStreamProvider.
-
AutoDisposeStreamProviderFamily<
R, Arg> - The Family of AutoDisposeStreamProvider.
-
AutoDisposeStreamProviderRef<
State> - An object used by providers to interact with other providers and the life-cycles of the application.
-
Bloc<
Event, State> -
Takes a
Stream
ofEvents
as input and transforms them into aStream
ofStates
as output. -
BlocBase<
State> - An interface for the core functionality implemented by both Bloc and Cubit.
-
BlocEventSink<
Event extends Object?> - An ErrorSink that supports adding events.
- BlocObserver
- An interface for observing the behavior of Bloc instances.
- BlocOverrides
- This class facilitates overriding BlocObserver and EventTransformer. It should be extended by another class in client code with overrides that construct a custom implementation. The implementation in this class defaults to the base blocObserver and eventTransformer implementation. For example:
-
BlocProvider<
B extends BlocBase< S> , S> - BlocProvider
-
BlocProviderElement<
B extends BlocBase< S> , S> - The element of StateNotifierProvider.
-
BlocProviderFamily<
B extends BlocBase< S> , S, Arg> - A class that allows building a BlocProvider from an external parameter.
- BlocProviderFamilyBuilder
- Builds a BlocProviderFamily.
-
BlocProviderRef<
B extends BlocBase< S> , S> -
Change<
State> -
A Change represents the change from one
State
to another. A Change consists of the currentState and nextState. - Closable
- An object that must be closed when no longer in use.
-
Cubit<
State> - A Cubit is similar to Bloc but has no notion of events and relies on methods to emit new states.
-
Emittable<
State extends Object?> - An object that can emit new states.
-
Emitter<
State> - An Emitter is a class which is capable of emitting new states.
- ErrorSink
- A generic destination for errors.
-
Family<
@Deprecated('The generic parameter will be removed in version 3.0.0. ' 'This is to enable riverpod_generator to implement families with generic parameters') State> - A base class for all families
-
FamilyAsyncNotifier<
State, Arg> - A Notifier implementation that is asynchronously initialized.
-
FamilyNotifier<
State, Arg> - A class which exposes a state that can change over time.
-
FamilyStreamNotifier<
State, Arg> - A variant of AsyncNotifier which has build creating a Stream.
-
FutureProvider<
T> - A provider that asynchronously creates a value.
-
FutureProviderElement<
T> - The element of a FutureProvider
-
FutureProviderFamily<
R, Arg> - The Family of a FutureProvider
-
FutureProviderRef<
State> - An object used by providers to interact with other providers and the life-cycles of the application.
- KeepAliveLink
- A object which maintains a provider alive.
-
Notifier<
State> - A class which exposes a state that can change over time.
-
NotifierProviderElement<
NotifierT extends NotifierBase< T> , T> - The element of NotifierProvider.
-
NotifierProviderFamily<
NotifierT extends FamilyNotifier< T, Arg> , T, Arg> - The Family of NotifierProvider.
-
NotifierProviderRef<
T> - An object used by providers to interact with other providers and the life-cycles of the application.
- Override
-
An object used by ProviderContainer/
ProviderScope
to override the behavior of a provider/family for part of the application. -
Provider<
State> - A provider that exposes a read-only value.
-
ProviderBase<
StateT> - A base class for all providers.
- ProviderContainer
- An object that stores the state of the providers and allows overriding the behavior of a specific provider.
-
ProviderElement<
State> - A provider that exposes a read-only value.
-
ProviderElementBase<
StateT> - An internal class that handles the state of a provider.
-
ProviderFamily<
R, Arg> - The Family of Provider
- ProviderListenableOrFamily
- A shared interface between ProviderListenable and Family.
- ProviderObserver
- An object that listens to the changes of a ProviderContainer.
- ProviderOrFamily
- A common interface shared by ProviderBase and Family
-
ProviderRef<
State> - An object used by providers to interact with other providers and the life-cycles of the application.
-
ProviderSubscription<
State> - Represents the subscription to a ProviderListenable
-
Ref<
State extends Object?> - An object used by providers to interact with other providers and the life-cycles of the application.
-
Refreshable<
T> -
An interface for provider expressions that can be passed to
ref.refresh
-
StateController<
T> - A StateNotifier that allows modifying its state from outside.
-
StateNotifier<
T> - An observable class that stores a single immutable state.
-
StateNotifierProvider<
NotifierT extends StateNotifier< T> , T> - Creates a StateNotifier and exposes its current state.
-
StateNotifierProviderElement<
NotifierT extends StateNotifier< T> , T> - The element of StateNotifierProvider.
-
StateNotifierProviderFamily<
NotifierT extends StateNotifier< T> , T, Arg> - The Family of StateNotifierProvider.
-
StateNotifierProviderRef<
NotifierT extends StateNotifier< T> , T> - An object used by providers to interact with other providers and the life-cycles of the application.
-
StateProvider<
T> - A provider that exposes a value that can be modified from outside.
-
StateProviderElement<
T> - The element of StateProvider.
-
StateProviderFamily<
R, Arg> - The Family of StateProvider.
-
StateProviderRef<
State> - An object used by providers to interact with other providers and the life-cycles of the application.
-
StateStreamable<
State> - A Streamable that provides synchronous access to the current state.
-
StateStreamableSource<
State> - A StateStreamable that must be closed when no longer in use.
-
Streamable<
State extends Object?> - An object that provides access to a stream of states over time.
-
StreamNotifier<
State> - A variant of AsyncNotifier which has build creating a Stream.
-
StreamNotifierProviderElement<
NotifierT extends AsyncNotifierBase< T> , T> - The element of StreamNotifierProvider.
-
StreamNotifierProviderFamily<
NotifierT extends FamilyStreamNotifier< T, Arg> , T, Arg> - The Family of StreamNotifierProvider.
-
StreamNotifierProviderRef<
T> - An object used by providers to interact with other providers and the life-cycles of the application.
-
StreamProvider<
T> - Creates a stream and exposes its latest event.
-
StreamProviderElement<
T> - The element of StreamProvider.
-
StreamProviderFamily<
R, Arg> - The Family of StreamProvider.
-
StreamProviderRef<
State> - An object used by providers to interact with other providers and the life-cycles of the application.
-
Transition<
Event, State> - A Transition is the change from one state to another. Consists of the currentState, an event, and the nextState.
Mixins
-
AlwaysAliveProviderBase<
State> - A base class for providers that never dispose themselves.
-
AlwaysAliveProviderListenable<
State> - A base class for all providers, used to consume a provider.
-
OverrideWithValueMixin<
State> - A mixin to add overrideWithValue capability to a provider.
-
ProviderListenable<
State> - A base class for all providers, used to consume a provider.
Extensions
-
AlwaysAliveProviderListenableWhenable
on AlwaysAliveProviderListenable<
S> -
Provides a when method like
listenWhen
orbuildWhen
in the commonBlocListener
orBlocBuilder
-
AsyncValueX
on AsyncValue<
T> - An extension that adds methods like when to an AsyncValue.
- OverrideWithProviderExtension on ProviderType
-
A mixin to add
overrideWithProvider
capability to providers. -
ProviderListenableWhenable
on ProviderListenable<
S> -
Provides a when method like
listenWhen
orbuildWhen
in the commonBlocListener
orBlocBuilder
Functions
-
describeIdentity(
Object? object) → String -
Returns a summary of the runtime type and hash code of
object
. -
shortHash(
Object? object) → String - Object.hashCode's 20 least-significant bits.
Typedefs
-
AsyncNotifierFamilyProvider<
NotifierT extends FamilyAsyncNotifier< T, Arg> , T, Arg> = FamilyAsyncNotifierProviderImpl<NotifierT, T, Arg> - A provider which creates and listen to an AsyncNotifier.
-
AsyncNotifierProvider<
NotifierT extends AsyncNotifier< T> , T> = AsyncNotifierProviderImpl<NotifierT, T> - A provider which creates and listen to an AsyncNotifier.
-
AutoDisposeAsyncNotifierProvider<
NotifierT extends AutoDisposeAsyncNotifier< T> , T> = AutoDisposeAsyncNotifierProviderImpl<NotifierT, T> - A provider which creates and listen to an AsyncNotifier.
-
AutoDisposeFamilyAsyncNotifierProvider<
NotifierT extends AutoDisposeFamilyAsyncNotifier< T, Arg> , T, Arg> = AutoDisposeFamilyAsyncNotifierProviderImpl<NotifierT, T, Arg> - A provider which creates and listen to an AsyncNotifier.
-
AutoDisposeFamilyNotifierProvider<
NotifierT extends AutoDisposeFamilyNotifier< T, Arg> , T, Arg> = AutoDisposeFamilyNotifierProviderImpl<NotifierT, T, Arg> - A Provider which exposes a Notifier and listens to it.
-
AutoDisposeFamilyStreamNotifierProvider<
NotifierT extends AutoDisposeFamilyStreamNotifier< T, Arg> , T, Arg> = AutoDisposeFamilyStreamNotifierProviderImpl<NotifierT, T, Arg> -
AutoDisposeNotifierProvider<
NotifierT extends AutoDisposeNotifier< T> , T> = AutoDisposeNotifierProviderImpl<NotifierT, T> - A Provider which exposes a Notifier and listens to it.
-
AutoDisposeStreamNotifierProvider<
NotifierT extends AutoDisposeStreamNotifier< T> , T> = AutoDisposeStreamNotifierProviderImpl<NotifierT, T> -
BlocUpdateCondition<
S> = bool Function(S previous, S current) -
Signature for the
shouldNotify
function which takes the previousstate
and the currentstate
and is responsible for returning a bool which determines whether or not to callref.listen()
orref.watch
with the currentstate
. - ErrorListener = void Function(Object error, StackTrace? stackTrace)
- A callback that can be passed to StateNotifier.onError.
-
EventHandler<
Event, State> = FutureOr< void> Function(Event event, Emitter<State> emit) -
An event handler is responsible for reacting to an incoming
Event
and can emit zero or more states via the Emitter. -
EventMapper<
Event> = Stream< Event> Function(Event event) - Signature for a function which converts an incoming event into an outbound stream of events. Used when defining custom EventTransformers.
-
EventTransformer<
Event> = Stream< Event> Function(Stream<Event> events, EventMapper<Event> mapper) - Used to change how events are processed. By default events are processed concurrently.
-
ListenWhen<
S> = bool Function(S previous, S current) -
Signature to decide
when
a ProviderListenable will rebuild. -
Locator
= T Function<
T>() - A function that allows obtaining other objects.
-
NotifierFamilyProvider<
NotifierT extends FamilyNotifier< T, Arg> , T, Arg> = FamilyNotifierProviderImpl<NotifierT, T, Arg> - The provider for NotifierProviderFamily.
-
NotifierProvider<
NotifierT extends Notifier< T> , T> = NotifierProviderImpl<NotifierT, T> - A Provider which exposes a Notifier and listens to it.
- RemoveListener = void Function()
- A callback that can be used to remove a listener added with StateNotifier.addListener.
-
StreamNotifierFamilyProvider<
NotifierT extends FamilyStreamNotifier< T, Arg> , T, Arg> = FamilyStreamNotifierProviderImpl<NotifierT, T, Arg> -
A variant of AsyncNotifier which has
build
creating a Stream. -
StreamNotifierProvider<
NotifierT extends StreamNotifier< T> , T> = StreamNotifierProviderImpl<NotifierT, T> -
A variant of AsyncNotifier which has
build
creating a Stream.
Exceptions / Errors
- CircularDependencyError
- An error thrown when a call to Ref.read/Ref.watch leads to a provider depending on itself.
-
DependencyNotFoundException<
T> -
Thrown when tried to call
LocatorMixin.read<T>()
, but theT
was not found.s - StateNotifierListenerError
- An error thrown when trying to update the state of a StateNotifier, but at least one of the listeners threw.
-
UnimplementedProviderError<
P extends ProviderOrFamily> - Error that will be throw when the provider is not implemented and must be overridden.