riverpod_annotation library

Classes

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.
AsyncNotifierProviderImpl<NotifierT extends AsyncNotifierBase<T>, T>
The implementation of AsyncNotifierProvider but with loosened type constraints that can be shared with AutoDisposeAsyncNotifierProvider.
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.
AutoDisposeAsyncNotifierProviderImpl<NotifierT extends AsyncNotifierBase<T>, T>
The implementation of AutoDisposeAsyncNotifierProvider but with loosened type constraints that can be shared with AsyncNotifierProvider.
AutoDisposeAsyncNotifierProviderRef<T>
An object used by providers to interact with other providers and the life-cycles of the application.
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
AutoDisposeNotifierProviderImpl<NotifierT extends NotifierBase<T>, T>
The implementation of AutoDisposeNotifierProvider but with loosened type constraints that can be shared with 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.
AutoDisposeStreamNotifier<State>
A variant of AsyncNotifier which has build creating a Stream.
AutoDisposeStreamNotifierProviderElement<NotifierT extends AsyncNotifierBase<T>, T>
The element of AutoDisposeStreamNotifierProvider.
AutoDisposeStreamNotifierProviderImpl<NotifierT extends AsyncNotifierBase<T>, T>
The implementation of AutoDisposeStreamNotifierProvider but with loosened type constraints that can be shared with 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.
BuildlessAsyncNotifier<State>
A AsyncNotifier base class shared between family and non-family notifiers.
BuildlessAutoDisposeAsyncNotifier<State>
A AutoDisposeAsyncNotifier base class shared between family and non-family notifiers.
BuildlessAutoDisposeNotifier<State>
An AutoDisposeNotifier base class shared between family and non-family notifiers.
BuildlessAutoDisposeStreamNotifier<State>
A AutoDisposeStreamNotifier base class shared between family and non-family notifiers.
BuildlessNotifier<State>
A Notifier base class shared between family and non-family notifiers.
BuildlessStreamNotifier<State>
A StreamNotifier base class shared between family and non-family notifiers.
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
FamilyOverride<@Deprecated('Will be removed in 3.0.0') State>
Do not use: Internal object to used by ProviderContainer/ProviderScope to override the behavior of a "family" for part of the application.
FutureOr<T>
A type representing values that are either Future<T> or T.
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.
Notifier<State>
A class which exposes a state that can change over time.
NotifierProviderElement<NotifierT extends NotifierBase<T>, T>
The element of NotifierProvider.
NotifierProviderImpl<NotifierT extends NotifierBase<T>, T>
The implementation of NotifierProvider but with loosened type constraints that can be shared with AutoDisposeNotifierProvider.
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.
ProviderElement<State>
A provider that exposes a read-only value.
ProviderFamily<R, Arg>
The Family of Provider
ProviderFor
An annotation used to help the linter find the user-defined element from the generated provider.
ProviderOrFamily
A common interface shared by ProviderBase and Family
ProviderOverride
An object used by ProviderContainer to override the behavior of a provider for a part of the application.
ProviderRef<State>
An object used by providers to interact with other providers and the life-cycles of the application.
Riverpod
An annotation placed on classes or functions.
StreamNotifier<State>
A variant of AsyncNotifier which has build creating a Stream.
StreamNotifierProviderElement<NotifierT extends AsyncNotifierBase<T>, T>
The element of StreamNotifierProvider.
StreamNotifierProviderImpl<NotifierT extends AsyncNotifierBase<T>, T>
The implementation of StreamNotifierProvider but with loosened type constraints that can be shared with AutoDisposeStreamNotifierProvider.
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.

Extensions

AsyncValueX on AsyncValue<T>
An extension that adds methods like when to an AsyncValue.

Constants

riverpod → const Riverpod
An annotation placed on classes or functions.
visibleForOverriding → const _VisibleForOverriding
Used to annotate an instance member that was made public so that it could be overridden but that is not intended to be referenced from outside the defining library.

Typedefs

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.
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>
NotifierProvider<NotifierT extends Notifier<T>, T> = NotifierProviderImpl<NotifierT, T>
A Provider which exposes a Notifier and listens to it.
Raw<T> = T
An annotation for marking a value type as "should not be handled by Riverpod".
StreamNotifierProvider<NotifierT extends StreamNotifier<T>, T> = StreamNotifierProviderImpl<NotifierT, T>
A variant of AsyncNotifier which has build creating a Stream.