BoxBase<E> class
abstract
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.
Write operations are asynchronous but the new values are immediately
available. The returned Future finishes when the change is written to
the backend. If this operation fails, the changes are being reverted.
Read operations for normal boxes are synchronous (the entries are in memory). Lazy boxes have asynchronous read operations.
Constructors
- BoxBase()
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- isEmpty → bool
-
Returns
trueif there are no entries in this box.no setter - isNotEmpty → bool
-
Returns true if there is at least one entries in this box.
no setter
- isOpen → bool
-
Whether this box is currently open.
no setter
- keys → Iterable
-
All the keys in the box.
no setter
- lazy → bool
-
Whether this box is lazy or not.
no setter
- length → int
-
The number of entries in the box.
no setter
- name → String
-
The name of the box. Names are always lowercase.
no setter
- path → String?
-
The location of the box in the file system. In the browser, this is null.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
add(
E value) → Future< int> -
Saves the
valuewith an auto-increment key. -
addAll(
Iterable< E> values) → Future<Iterable< int> > -
Saves all the
valueswith auto-increment keys. -
clear(
) → Future< int> - Removes all entries from the box.
-
close(
) → Future< void> - Closes the box.
-
compact(
) → Future< void> - Induces compaction manually. This is rarely needed. You should consider providing a custom compaction strategy instead.
-
containsKey(
dynamic key) → bool -
Checks whether the box contains the
key. -
delete(
dynamic key) → Future< void> -
Deletes the given
keyfrom the box. -
deleteAll(
Iterable keys) → Future< void> -
Deletes all the given
keysfrom the box. -
deleteAt(
int index) → Future< void> - Deletes the n-th key from the box.
-
deleteFromDisk(
) → Future< void> - Removes the file which contains the box and closes the box.
-
flush(
) → Future< void> - Flushes all pending changes of the box to disk.
-
keyAt(
int index) → dynamic - Get the n-th key in the box.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
put(
dynamic key, E value) → Future< void> -
Saves the
key-valuepair. -
putAll(
Map< dynamic, E> entries) → Future<void> -
Saves all the key - value pairs in the
entriesmap. -
putAt(
int index, E value) → Future< void> -
Associates the
valuewith the n-th key. An exception is raised if the key does not exist. -
toString(
) → String -
A string representation of this object.
inherited
-
watch(
{dynamic key}) → Stream< BoxEvent> - Returns a broadcast stream of change events.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited