Skip to content

Commit 025bc51

Browse files
simcsimc
committed
Fix #98 
1 parent 61f58a8 commit 025bc51

9 files changed

+147
-57
lines changed

‎hive/CHANGELOG.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
1+
## 1.1.0+2
2+
3+
### Fixes
4+
- Fixed bug that it was not possible to open typed boxes (`Box<E>`)
5+
16
## 1.1.0+1
2-
- Bugfix
7+
8+
### Fixes
9+
- Fixed bug that corrupted boxes were not detected
310

411
## 1.1.0
512

‎hive/lib/src/binary/frame.dart

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ import 'package:hive/src/binary/binary_writer_impl.dart';
44
import 'package:hive/src/crypto_helper.dart';
55
import 'package:hive/src/util/crc32.dart';
66

7-
class Frame<E> {
7+
class Frame {
88
final dynamic key;
9-
final E value;
9+
final dynamic value;
1010
final bool deleted;
1111
final bool lazy;
1212

‎hive/lib/src/box/box_base.dart

+2
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ abstract class BoxBase<E> implements Box<E> {
3333
keystore = Keystore(this, ChangeNotifier(), keyComparator);
3434
}
3535

36+
Type get valueType => E;
37+
3638
@override
3739
bool get isOpen => _open;
3840

‎hive/lib/src/box/box_impl.dart

+6-6
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ class BoxImpl<E> extends BoxBase<E> {
3131

3232
var frame = keystore.get(key);
3333
if (frame != null) {
34-
return frame.value;
34+
return frame.value as E;
3535
} else {
3636
return defaultValue;
3737
}
@@ -41,12 +41,12 @@ class BoxImpl<E> extends BoxBase<E> {
4141
E getAt(int index) {
4242
checkOpen();
4343

44-
return keystore.getAt(index).value;
44+
return keystore.getAt(index).value as E;
4545
}
4646

4747
@override
4848
Future<void> putAll(Map<dynamic, E> kvPairs) {
49-
var frames = <Frame<E>>[];
49+
var frames = <Frame>[];
5050
for (var key in kvPairs.keys) {
5151
frames.add(Frame(key, kvPairs[key]));
5252
}
@@ -56,7 +56,7 @@ class BoxImpl<E> extends BoxBase<E> {
5656

5757
@override
5858
Future<void> deleteAll(Iterable<dynamic> keys) {
59-
var frames = <Frame<E>>[];
59+
var frames = <Frame>[];
6060
for (var key in keys) {
6161
if (keystore.containsKey(key)) {
6262
frames.add(Frame.deleted(key));
@@ -66,7 +66,7 @@ class BoxImpl<E> extends BoxBase<E> {
6666
return _writeFrames(frames);
6767
}
6868

69-
Future<void> _writeFrames(List<Frame<E>> frames) async {
69+
Future<void> _writeFrames(List<Frame> frames) async {
7070
checkOpen();
7171

7272
if (!keystore.beginTransaction(frames)) return;
@@ -86,7 +86,7 @@ class BoxImpl<E> extends BoxBase<E> {
8686
Map<dynamic, E> toMap() {
8787
var map = <dynamic, E>{};
8888
for (var frame in keystore.frames) {
89-
map[frame.key] = frame.value;
89+
map[frame.key] = frame.value as E;
9090
}
9191
return map;
9292
}

‎hive/lib/src/box/keystore.dart

+10-10
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import 'package:meta/meta.dart';
99

1010
class KeyTransaction<E> {
1111
final List<dynamic> added = [];
12-
final Map<dynamic, Frame<E>> deleted = HashMap();
12+
final Map<dynamic, Frame> deleted = HashMap();
1313

1414
@visibleForTesting
1515
KeyTransaction();
@@ -28,7 +28,7 @@ class Keystore<E> {
2828

2929
final ChangeNotifier _notifier;
3030

31-
final IndexableSkipList<dynamic, Frame<E>> _store;
31+
final IndexableSkipList<dynamic, Frame> _store;
3232

3333
@visibleForTesting
3434
final ListQueue<KeyTransaction<E>> transactions = ListQueue();
@@ -40,7 +40,7 @@ class Keystore<E> {
4040
: _store = IndexableSkipList(keyComparator ?? _compareKeys);
4141

4242
factory Keystore.debug({
43-
Iterable<Frame<E>> frames = const [],
43+
Iterable<Frame> frames = const [],
4444
Box<E> box,
4545
ChangeNotifier notifier,
4646
KeyComparator keyComparator,
@@ -57,7 +57,7 @@ class Keystore<E> {
5757

5858
int get length => _store.length;
5959

60-
Iterable<Frame<E>> get frames => _store.values;
60+
Iterable<Frame> get frames => _store.values;
6161

6262
void resetDeletedEntries() {
6363
_deletedEntries = 0;
@@ -81,11 +81,11 @@ class Keystore<E> {
8181
return _store.getKeyAt(index);
8282
}
8383

84-
Frame<E> get(dynamic key) {
84+
Frame get(dynamic key) {
8585
return _store.get(key);
8686
}
8787

88-
Frame<E> getAt(int index) {
88+
Frame getAt(int index) {
8989
return _store.getAt(index);
9090
}
9191

@@ -94,15 +94,15 @@ class Keystore<E> {
9494
}
9595

9696
Iterable<E> getValues() {
97-
return _store.values.map((e) => e.value);
97+
return _store.values.map((e) => e.value as E);
9898
}
9999

100100
Stream<BoxEvent> watch({dynamic key}) {
101101
return _notifier.watch(key: key);
102102
}
103103

104-
Frame<E> insert(Frame<E> frame, [bool notify = true]) {
105-
Frame<E> deletedFrame;
104+
Frame insert(Frame frame, [bool notify = true]) {
105+
Frame deletedFrame;
106106

107107
if (!frame.deleted) {
108108
var key = frame.key;
@@ -133,7 +133,7 @@ class Keystore<E> {
133133
return deletedFrame;
134134
}
135135

136-
bool beginTransaction(List<Frame<E>> newFrames) {
136+
bool beginTransaction(List<Frame> newFrames) {
137137
var transaction = KeyTransaction<E>();
138138
for (var frame in newFrames) {
139139
if (!frame.deleted) {

‎hive/lib/src/hive.dart

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ abstract class HiveInterface implements TypeRegistry {
1717
///
1818
/// If the box is already open, the instance is returned and all provided
1919
/// parameters are being ignored.
20-
Future<Box> openBox(
20+
Future<Box<E>> openBox<E>(
2121
String name, {
2222
List<int> encryptionKey,
2323
KeyComparator keyComparator,
@@ -29,15 +29,15 @@ abstract class HiveInterface implements TypeRegistry {
2929
/// Opens an in-memory box from a list of bytes. It does not persist changes.
3030
///
3131
/// This is useful for opening boxes from an asset file.
32-
Future<Box> openBoxFromBytes(
32+
Future<Box<E>> openBoxFromBytes<E>(
3333
String name,
3434
Uint8List bytes, {
3535
List<int> encryptionKey,
3636
KeyComparator keyComparator,
3737
});
3838

3939
/// Returns a previously opened box.
40-
Box box(String name);
40+
Box<E> box<E>(String name);
4141

4242
/// Checks if a specific box is currently open.
4343
bool isBoxOpen(String name);

‎hive/lib/src/hive_impl.dart

+26-9
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ class HiveImpl extends TypeRegistryImpl implements HiveInterface {
5353
}
5454

5555
@override
56-
Future<Box> openBox(
56+
Future<Box<E>> openBox<E>(
5757
String name, {
5858
List<int> encryptionKey,
5959
KeyComparator keyComparator,
@@ -62,16 +62,27 @@ class HiveImpl extends TypeRegistryImpl implements HiveInterface {
6262
bool lazy = false,
6363
}) async {
6464
if (isBoxOpen(name)) {
65-
return box(name);
65+
var openedBox = box<E>(name);
66+
if (openedBox.lazy != lazy) {
67+
throw HiveError(
68+
'The box "$name" is already open. You cannot open a box as lazy '
69+
'and non-lazy at the same time.');
70+
}
71+
return openedBox;
6672
} else {
6773
var cs = compactionStrategy ?? defaultCompactionStrategy;
6874
var crypto = getCryptoHelper(encryptionKey);
6975
var backend = await openBackend(this, name, lazy, crashRecovery, crypto);
70-
BoxBase box;
76+
BoxBase<E> box;
7177
if (lazy) {
72-
box = LazyBoxImpl(this, name, keyComparator, cs, backend);
78+
if (E == dynamic) {
79+
var lazyBox = LazyBoxImpl(this, name, keyComparator, cs, backend);
80+
box = lazyBox as BoxBase<E>;
81+
} else {
82+
throw HiveError('Lazy boxes do not support type arguments.');
83+
}
7384
} else {
74-
box = BoxImpl(this, name, keyComparator, cs, backend);
85+
box = BoxImpl<E>(this, name, keyComparator, cs, backend);
7586
}
7687
await box.initialize();
7788
_boxes[name.toLowerCase()] = box;
@@ -81,7 +92,7 @@ class HiveImpl extends TypeRegistryImpl implements HiveInterface {
8192
}
8293

8394
@override
84-
Future<Box> openBoxFromBytes(
95+
Future<Box<E>> openBoxFromBytes<E>(
8596
String name,
8697
Uint8List bytes, {
8798
List<int> encryptionKey,
@@ -92,7 +103,7 @@ class HiveImpl extends TypeRegistryImpl implements HiveInterface {
92103
} else {
93104
var crypto = getCryptoHelper(encryptionKey);
94105
var backend = StorageBackendMemory(bytes, crypto);
95-
var box = BoxImpl(this, name, keyComparator, null, backend);
106+
var box = BoxImpl<E>(this, name, keyComparator, null, backend);
96107
await box.initialize();
97108
_boxes[name.toLowerCase()] = box;
98109

@@ -101,9 +112,15 @@ class HiveImpl extends TypeRegistryImpl implements HiveInterface {
101112
}
102113

103114
@override
104-
Box box(String name) {
115+
Box<E> box<E>(String name) {
105116
if (isBoxOpen(name)) {
106-
return _boxes[name.toLowerCase()];
117+
var box = _boxes[name.toLowerCase()] as BoxBase;
118+
if (box.valueType == E) {
119+
return box as Box<E>;
120+
} else {
121+
throw HiveError('The box "$name" is already open and of type '
122+
'Box<${box.valueType}>. You cannot open the same box as Box<$E>.');
123+
}
107124
} else {
108125
throw HiveError('Box not found. Did you forget to call Hive.openBox()?');
109126
}

‎hive/pubspec.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: hive
22
description: Lightweight and blazing fast key-value database written in pure Dart. Stronly encrypted using AES-256.
3-
version: 1.1.0+1
3+
version: 1.1.0+2
44
author: Simon Leier <[email protected]>
55
homepage: https://github.com/hivedb/hive
66

0 commit comments

Comments
 (0)