1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
// Copyright 2017, 2018 Parity Technologies // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. //! Generic trait for trie node encoding/decoding. Takes a `hash_db::Hasher` //! to parametrize the hashes used in the codec. use hash_db::Hasher; use node::Node; use ChildReference; #[cfg(feature = "std")] use std::error::Error; #[cfg(not(feature = "std"))] use alloc::vec::Vec; use elastic_array::ElasticArray128; #[cfg(not(feature = "std"))] pub trait Error {} #[cfg(not(feature = "std"))] impl<T> Error for T {} /// Trait for trie node encoding/decoding pub trait NodeCodec<H: Hasher>: Sized { /// Codec error type type Error: Error; /// Get the hashed null node. fn hashed_null_node() -> H::Out; /// Decode bytes to a `Node`. Returns `Self::E` on failure. fn decode(data: &[u8]) -> Result<Node, Self::Error>; /// Decode bytes to the `Hasher`s output type. Returns `None` on failure. fn try_decode_hash(data: &[u8]) -> Option<H::Out>; /// Check if the provided bytes correspond to the codecs "empty" node. fn is_empty_node(data: &[u8]) -> bool; /// Returns an empty node fn empty_node() -> Vec<u8>; /// Returns an encoded leaf node fn leaf_node(partial: &[u8], value: &[u8]) -> Vec<u8>; /// Returns an encoded extension node fn ext_node(partial: &[u8], child_ref: ChildReference<H::Out>) -> Vec<u8>; /// Returns an encoded branch node. Takes an iterator yielding `ChildReference<H::Out>` and an optional value fn branch_node<I>(children: I, value: Option<ElasticArray128<u8>>) -> Vec<u8> where I: IntoIterator<Item=Option<ChildReference<H::Out>>> + Iterator<Item=Option<ChildReference<H::Out>>>; }