live_stream library

Classes

AsyncLiveStream<State extends Object?>
AsyncState<State>
BindableObject
BindableProperty<State>
LiveStream
LiveStreamBase
LiveStreamBuilder<B extends LiveStream, S>
LiveStreamBuilder handles building a widget in response to new states. LiveStreamBuilder is analogous to StreamBuilder but has simplified API to reduce the amount of boilerplate code needed as well as LiveStream-specific performance improvements. Please refer to LiveStreamListener if you want to "do" anything in response to state changes such as navigation, showing a dialog, etc...
LiveStreamBuilderBase<B extends LiveStream, S>
Base class for widgets that listen to state changes in a specified Stream.
LiveStreamListener<B extends LiveStream, S>
Takes a StreamWidgetListener and an optional liveStream and SyncLiveStream invokes the listener in response to state changes in the SyncLiveStream. It should be used for functionality that needs to occur only in response to a state change such as navigation, showing a SnackBar, showing a Dialog, etc... The listener is guaranteed to only be called once for each state change unlike the builder in LiveStreamBuilder.
LiveStreamListenerBase<B extends LiveStream, S>
Base class for widgets that listen to state changes in a specified Stream.
LiveStreamListenerCallback<State>
LiveStreamListenerVoidCallback<State>
LiveStreamProvider<LS extends LiveStream>
The LiveStreamProvider class depends on InheritedWidget. It accepts a liveStream and a widget.
LiveStreamProviderBase<LS extends LiveStream>
MultiLiveStreamListener
Merges multiple LiveStreamListener widgets into one widget tree.
MultiLiveStreamProvider
Merges multiple LiveStreamProvider widgets into one widget tree.
OnData<State>
OnError<State>
OnLoading<State>
Pure<State>
StateStreamable<State>
A Streamable that provides synchronous access to the current state.
StreamBase<State>
An object that provides access to a stream of states over time.
ValueListenable<State>
  • ValueListenable, a widget that uses a builder callback to rebuild whenever a ValueListenable object triggers its notifications, providing the builder with the value of the object.
    • ValueLiveStream<State>

    Enums

    Status

    Mixins

    BindableObjectAsyncValueMixin
    BindableObjectAsyncValueMixin
    BindableObjectValueMixin
    BindableObjectValueMixin
    LiveStreamListenerSingleChildWidget
    Mixin which allows MultiLiveStreamListener to infer the types of multiple LiveStreamListeners.
    LiveStreamSingleChildWidget
    Mixin which allows MultiLiveStreamProvider to infer the types of multiple LiveStreamProviders.

    Typedefs

    LiveStreamListenerVoidCallbackFunction = void Function()
    LiveStreamListenerWidgetCallback = Widget Function()
    PropertyValueChanged<State> = void Function(State value)
    StreamWidgetBuilder = Widget Function(BuildContext context, ValueListenable state)
    Signature for the builder function which takes the BuildContext and state and is responsible for returning a widget which is to be rendered. This is analogous to the builder function in StreamBuilder.
    StreamWidgetListener = void Function(BuildContext context, ValueListenable state)
    Signature for the builder function which takes the BuildContext and state and is responsible for returning a VOID which is to be rendered. This is analogous to the builder function in StreamBuilder.
    UpdateShouldNotify<T> = bool Function(T liveStream, _LiveStreamProvider<LiveStream> oldWidget)
    Function used to customize the update policy

    Exceptions / Errors

    NotfoundPropertyException
    NotfoundPropertyException
    PropertyException
    PropertyException