From be1e247d575416e524a9b51218d90a9db23b90db Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bastian=20K=C3=B6cher?= <bkchr@users.noreply.github.com>
Date: Wed, 26 Feb 2020 12:14:07 +0100
Subject: [PATCH] Adds documentation for `wipe` and `commit` (#5053)
* Adds documentation for `wipe` and `commit`
This adds documentation to `wipe` and `commit` of `Externalities`.
Besides that it removes the default implementation that would just panic
and requires that all implementers of the trait implement the functions.
* Update primitives/externalities/src/lib.rs
Co-Authored-By: joe petrowski <25483142+joepetrowski@users.noreply.github.com>
Co-authored-by: joe petrowski <25483142+joepetrowski@users.noreply.github.com>
---
substrate/primitives/externalities/src/lib.rs | 20 +++++++++++++------
.../primitives/state-machine/src/basic.rs | 4 ++++
2 files changed, 18 insertions(+), 6 deletions(-)
diff --git a/substrate/primitives/externalities/src/lib.rs b/substrate/primitives/externalities/src/lib.rs
index 431e449846c..fa0f9e4454d 100644
--- a/substrate/primitives/externalities/src/lib.rs
+++ b/substrate/primitives/externalities/src/lib.rs
@@ -203,13 +203,21 @@ pub trait Externalities: ExtensionStore {
/// Returns the SCALE encoded hash.
fn storage_changes_root(&mut self, parent: &[u8]) -> Result<Option<Vec<u8>>, ()>;
- fn wipe(&mut self) {
- unimplemented!()
- }
+ /// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ /// Benchmarking related functionality and shouldn't be used anywhere else!
+ /// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ ///
+ /// Wipes all changes from caches and the database.
+ ///
+ /// The state will be reset to genesis.
+ fn wipe(&mut self);
- fn commit(&mut self) {
- unimplemented!()
- }
+ /// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ /// Benchmarking related functionality and shouldn't be used anywhere else!
+ /// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ ///
+ /// Commits all changes to the database and clears all caches.
+ fn commit(&mut self);
}
/// Extension for the [`Externalities`] trait.
diff --git a/substrate/primitives/state-machine/src/basic.rs b/substrate/primitives/state-machine/src/basic.rs
index d905657737a..966648bc824 100644
--- a/substrate/primitives/state-machine/src/basic.rs
+++ b/substrate/primitives/state-machine/src/basic.rs
@@ -298,6 +298,10 @@ impl Externalities for BasicExternalities {
fn storage_changes_root(&mut self, _parent: &[u8]) -> Result<Option<Vec<u8>>, ()> {
Ok(None)
}
+
+ fn wipe(&mut self) {}
+
+ fn commit(&mut self) {}
}
impl sp_externalities::ExtensionStore for BasicExternalities {
--
GitLab