nosql_persistence library
Classes
- AndroidOptions
- AppleOptions
- 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.
-
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.
- BoxCollection
- BoxEvent
- A event representing a change in a box.
-
CollectionBox<
V> - represents a Box being part of a BoxCollection
- FlutterSecureStorage
- HiveAesCipher
- Default encryption algorithm. Uses AES256 CBC with PKCS7 padding.
- HiveCipher
- Abstract cipher can be implemented to customize encryption.
-
HiveCollection<
E extends HiveObjectMixin> - List containing HiveObjectMixins.
- HiveField
- Annotate all fields you want to persist with HiveField.
- HiveInterface
-
The main API interface of Hive. Available through the
Hiveconstant. -
HiveList<
E extends HiveObjectMixin> - Allows defining references to other HiveObjectMixins.
- HiveObject
- HiveType
-
Annotate classes with HiveType to generate a
TypeAdapter. - IOSOptions
- Specific options for iOS platform.
-
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.
- LinuxOptions
- Specific options for Linux platform. Currently there are no specific linux options available.
- MacOsOptions
- Specific options for macOS platform.
- PersistenceInterface
- SecureDataSource
- Implementation of the PersistenceInterface for Hive. Use this to store data without worrying about performance. Be sure to call initAsync after the constructor and wait for it to execute. Calling dispose is desirable, but not necessary.
- StorageDataSource
- Implementation of the PersistenceInterface for FlutterSecureStorage. Use this to store private data, of which there is a small amount. Be sure to call initAsync after the constructor and wait for it to execute. Calling dispose is desirable, but not necessary.
-
TypeAdapter<
T> - Type adapters can be implemented to support non primitive values.
- TypeRegistry
- TypeRegistries contain the TypeAdapters associated with a typeId.
- WatchBoxBuilder
- A general-purpose widget which rebuilds itself when the box or a specific key change.
- WebOptions
- Specific options for web platform.
- WindowsOptions
- Specific options for Windows platform.
Enums
- HiveStorageBackendPreference
- declares the preferred JS StorageBackend to be used
- KeychainAccessibility
- KeyChain accessibility attributes as defined here: https://developer.apple.com/documentation/security/ksecattraccessible?language=objc
- KeyCipherAlgorithm
- StorageCipherAlgorithm
Mixins
- HiveObjectMixin
-
Extend
HiveObjectto add useful methods to the objects you want to store in Hive
Extensions
Properties
- Hive → HiveInterface
-
Global constant to access Hive.
final
Typedefs
-
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.