openethereum/util/src/hashdb.rs

139 lines
4.2 KiB
Rust
Raw Normal View History

2016-02-05 13:40:41 +01:00
// Copyright 2015, 2016 Ethcore (UK) Ltd.
// This file is part of Parity.
// Parity is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Parity is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Parity. If not, see <http://www.gnu.org/licenses/>.
2015-12-07 17:20:15 +01:00
//! Database of byte-slices keyed to their Keccak hash.
2015-11-28 00:14:40 +01:00
use hash::*;
2015-11-30 02:57:02 +01:00
use bytes::*;
use std::collections::HashMap;
2015-11-28 00:14:40 +01:00
2015-12-07 17:20:15 +01:00
/// Trait modelling datastore keyed by a 32-byte Keccak hash.
pub trait HashDB: AsHashDB + Send + Sync {
/// Get the keys in the database together with number of underlying references.
2015-12-04 18:05:59 +01:00
fn keys(&self) -> HashMap<H256, i32>;
/// Look up a given hash into the bytes that hash to it, returning None if the
2015-11-28 01:38:36 +01:00
/// hash is not known.
///
/// # Examples
/// ```rust
/// extern crate ethcore_util;
/// use ethcore_util::hashdb::*;
/// use ethcore_util::memorydb::*;
/// fn main() {
/// let mut m = MemoryDB::new();
/// let hello_bytes = "Hello world!".as_bytes();
/// let hash = m.insert(hello_bytes);
/// assert_eq!(m.get(&hash).unwrap(), hello_bytes);
2015-11-28 01:38:36 +01:00
/// }
/// ```
fn get(&self, key: &H256) -> Option<&[u8]>;
2015-11-28 01:38:36 +01:00
/// Check for the existance of a hash-key.
///
/// # Examples
/// ```rust
/// extern crate ethcore_util;
/// use ethcore_util::hashdb::*;
/// use ethcore_util::memorydb::*;
/// use ethcore_util::sha3::*;
/// fn main() {
/// let mut m = MemoryDB::new();
/// let hello_bytes = "Hello world!".as_bytes();
/// assert!(!m.contains(&hello_bytes.sha3()));
2015-11-28 01:38:36 +01:00
/// let key = m.insert(hello_bytes);
/// assert!(m.contains(&key));
/// m.remove(&key);
/// assert!(!m.contains(&key));
2015-11-28 01:38:36 +01:00
/// }
/// ```
fn contains(&self, key: &H256) -> bool;
2015-11-28 01:38:36 +01:00
/// Insert a datum item into the DB and return the datum's hash for a later lookup. Insertions
/// are counted and the equivalent number of `remove()`s must be performed before the data
2015-11-28 01:38:36 +01:00
/// is considered dead.
///
/// # Examples
/// ```rust
/// extern crate ethcore_util;
/// use ethcore_util::hashdb::*;
/// use ethcore_util::memorydb::*;
/// use ethcore_util::hash::*;
/// fn main() {
/// let mut m = MemoryDB::new();
/// let key = m.insert("Hello world!".as_bytes());
/// assert!(m.contains(&key));
2015-11-28 01:38:36 +01:00
/// }
/// ```
2015-11-28 00:14:40 +01:00
fn insert(&mut self, value: &[u8]) -> H256;
2015-11-28 01:38:36 +01:00
2015-11-30 02:57:02 +01:00
/// Like `insert()` , except you provide the key and the data is all moved.
fn emplace(&mut self, key: H256, value: Bytes);
2015-11-28 01:38:36 +01:00
/// Remove a datum previously inserted. Insertions can be "owed" such that the same number of `insert()`s may
/// happen without the data being eventually being inserted into the DB.
///
/// # Examples
/// ```rust
/// extern crate ethcore_util;
/// use ethcore_util::hashdb::*;
/// use ethcore_util::memorydb::*;
/// use ethcore_util::sha3::*;
/// fn main() {
/// let mut m = MemoryDB::new();
/// let d = "Hello world!".as_bytes();
/// let key = &d.sha3();
/// m.remove(key); // OK - we now owe an insertion.
/// assert!(!m.contains(key));
2015-11-28 01:38:36 +01:00
/// m.insert(d); // OK - now it's "empty" again.
/// assert!(!m.contains(key));
2015-11-28 01:38:36 +01:00
/// m.insert(d); // OK - now we've
/// assert_eq!(m.get(key).unwrap(), d);
2015-11-28 01:38:36 +01:00
/// }
/// ```
fn remove(&mut self, key: &H256);
2016-06-27 09:16:34 +02:00
/// Insert auxiliary data into hashdb.
fn insert_aux(&mut self, _hash: Vec<u8>, _value: Vec<u8>) {
unimplemented!();
}
/// Get auxiliary data from hashdb.
fn get_aux(&self, _hash: &[u8]) -> Option<Vec<u8>> {
unimplemented!();
}
/// Removes auxiliary data from hashdb.
fn remove_aux(&mut self, _hash: &[u8]) {
unimplemented!();
}
2015-11-28 00:14:40 +01:00
}
/// Upcast trait.
pub trait AsHashDB {
/// Perform upcast to HashDB for anything that derives from HashDB.
fn as_hashdb(&self) -> &HashDB;
/// Perform mutable upcast to HashDB for anything that derives from HashDB.
fn as_hashdb_mut(&mut self) -> &mut HashDB;
}
impl<T: HashDB> AsHashDB for T {
fn as_hashdb(&self) -> &HashDB {
self
}
fn as_hashdb_mut(&mut self) -> &mut HashDB {
self
}
}