Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Adds documentation for wipe and commit #5053

Merged
merged 2 commits into from
Feb 26, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions primitives/externalities/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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 resetted to genesis.
bkchr marked this conversation as resolved.
Show resolved Hide resolved
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.
Expand Down
4 changes: 4 additions & 0 deletions primitives/state-machine/src/basic.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down