LazyBox<E> class abstract

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

Inheritance
Available Extensions

Constructors

LazyBox()

Properties

hashCode → int
The hash code for this object.
no setterinherited
isEmpty → bool
Returns true if there are no entries in this box.
no setterinherited
isNotEmpty → bool
Returns true if there is at least one entries in this box.
no setterinherited
isOpen → bool
Whether this box is currently open.
no setterinherited
keys → Iterable
All the keys in the box.
no setterinherited
lazy → bool
Whether this box is lazy or not.
no setterinherited
length → int
The number of entries in the box.
no setterinherited
name → String
The name of the box. Names are always lowercase.
no setterinherited
path → String?
The location of the box in the file system. In the browser, this is null.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

add(E value, {bool notify = true}) → Future<int>
Saves the value with an auto-increment key.
inherited
addAll(Iterable<E> values, {bool notify = true}) → Future<Iterable<int>>
Saves all the values with auto-increment keys.
inherited
clear({bool notify = true}) → Future<int>
Removes all entries from the box.
inherited
close() → Future<void>
Closes the box.
inherited
compact() → Future<void>
Induces compaction manually. This is rarely needed. You should consider providing a custom compaction strategy instead.
inherited
containsKey(dynamic key) → bool
Checks whether the box contains the key.
inherited
delete(dynamic key, {bool notify = true}) → Future<void>
Beta: Performs the following write-only operations in memory and later flushes
inherited
deleteAll(Iterable keys, {bool notify = true}) → Future<void>
Deletes all the given keys from the box.
inherited
deleteAt(int index, {bool notify = true}) → Future<void>
Deletes the n-th key from the box.
inherited
deleteFromDisk() → Future<void>
Removes the file which contains the box and closes the box.
inherited
flush() → Future<void>
Flushes all pending changes of the box to disk.
inherited
get(dynamic key, {E? defaultValue}) → Future<E?>
Returns the value associated with the given key. If the key does not exist, null is returned.
getAt(int index) → Future<E?>
Returns the value associated with the n-th key.
keyAt(int index) → dynamic
Get the n-th key in the box.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
put(dynamic key, E value, {bool notify = true}) → Future<void>
Saves the key - value pair.
inherited
putAll(Map<dynamic, E> entries, {bool notify = true}) → Future<void>
Saves all the key - value pairs in the entries map.
inherited
putAt(int index, E value, {bool notify = true}) → Future<void>
Associates the value with the n-th key. An exception is raised if the key does not exist.
inherited
toString() → String
A string representation of this object.
inherited
watch({dynamic key}) → Stream<BoxEvent>
Returns a broadcast stream of change events.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited