bolter_flutter library

Classes

BinaryReader

The BinaryReader is used to bring data back from the binary format on the disk.

BinaryWriter

The BinaryWriter is used to encode data to the binary format.

Bolter

BolterNavigator<P extends NavigationPresenter>

BolterProvider

BolterRoute<R>

BolterTabNavigator<P extends TabNavigationPresenter>

Box<E>

Boxes contain all of your data. In the browser, each box has its own IndexedDB database. On all other platforms, each Box is stored in a separate file in the Hive home directory.

BoxBase<E>

Boxes contain all of your data. In the browser, each box has its own IndexedDB database. On all other platforms, each Box is stored in a seperate file in the Hive home directory.

BoxEvent

A event representing a change in a box.

ComparableWrapper<V>

Equatable

A base class to facilitate operator == and hashCode overrides.

EquatableConfig

The default configurion for all Equatable instances.

HiveAesCipher

Default encryption algorithm. Uses AES256 CBC with PKCS7 padding.

HiveCipher

Abstract cipher can be implemented to customize encryption.

HiveCollection<E extends HiveObject>

List containing HiveObjects.

HiveField

Annotate all fields you want to persist with HiveField.

HiveInterface

The main API interface of Hive. Available through the Hive constant.

HiveList<E extends HiveObject>

Allows defining references to other HiveObjects.

HiveObject

Extend HiveObject to add useful methods to the objects you want to store in Hive

HiveType

Annotate classes with HiveType to generate a TypeAdapter.

LazyBox<E>

LazyBoxes don't keep the values in memory like normal boxes. Each time a value is read, it is loaded from the backend.

MultiPresenterProvider

Navigation

NavigationAdapter

Persist<FS>

PersistLifecycleWrapper<FS>

PersistRepository<FS>

Presenter<FS>

PresenterProvider<P extends Presenter>

PresenterProviderState<P extends Presenter>

RestoreRepository<T>

RestoreRepositoryImpl<T>

TabNavigation

TabNavigationAdapter

TypeAdapter<T>

Type adapters can be implemented to support non primitive values.

TypeRegistry

TypeRegistries contain the TypeAdapters associated with a typeId.

UseCaseContainer

ValueStream<T>

ValueStreamBuilder<T>

WatchBoxBuilder

A general-purpose widget which rebuilds itself when the box or a specific key change.

Mixins

EquatableMixin

A mixin that helps implement equality without needing to explicitly override operator == and hashCode.

NavigationPresenter<FS>

TabNavigationPresenter<FS>

Extensions

BoxX on Box<T>

Flutter extensions for boxes.

HiveX on HiveInterface

Flutter extensions for Hive.

LazyBoxX on LazyBox<T>

Flutter extensions for lazy boxes.

PresenterProviderExtension on BuildContext

Properties

Hive → HiveInterface

Global constant to access Hive.

final

Functions

registerBolterFlutterAdapters() → void

throwException<T>() → T

Typedefs

BolterDialog = Future Function(BuildContext context)

BoxWidgetBuilder<T> = Widget Function(BuildContext context, Box<T> box)

Signature for a function that builds a widget given a Box.

CompactionStrategy = bool Function(int entries, int deletedEntries)

A function which decides when to compact a box.

KeyComparator = int Function(dynamic key1, dynamic key2)

Exceptions / Errors

HiveError

An error related to Hive.

NoRouteException

UseCaseNotFoundException