Skip to content

Change trait to take self by value #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
michaelsproul wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Change trait to take self by value #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37e96ae
Change trait to take self by value
michaelsproul Sep 13, 2024
479e6d0
Tweak
michaelsproul Sep 13, 2024
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
75 changes: 39 additions & 36 deletions tree_hash/src/impls.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ fn int_to_hash256(int: u64) -> Hash256 {

macro_rules! impl_for_bitsize {
($type: ident, $bit_size: expr) => {
impl TreeHash for $type {
impl TreeHash for &$type {
fn tree_hash_type() -> TreeHashType {
TreeHashType::Basic
}

fn tree_hash_packed_encoding(&self) -> PackedEncoding {
fn tree_hash_packed_encoding(self) -> PackedEncoding {
PackedEncoding::from_slice(&self.to_le_bytes())
}

Expand All @@ -24,7 +24,7 @@ macro_rules! impl_for_bitsize {
}

#[allow(clippy::cast_lossless)] // Lint does not apply to all uses of this macro.
fn tree_hash_root(&self) -> Hash256 {
fn tree_hash_root(self) -> Hash256 {
int_to_hash256(*self as u64)
}
}
Expand All @@ -37,41 +37,41 @@ impl_for_bitsize!(u32, 32);
impl_for_bitsize!(u64, 64);
impl_for_bitsize!(usize, 64);

impl TreeHash for bool {
impl TreeHash for &bool {
fn tree_hash_type() -> TreeHashType {
TreeHashType::Basic
}

fn tree_hash_packed_encoding(&self) -> PackedEncoding {
fn tree_hash_packed_encoding(self) -> PackedEncoding {
(*self as u8).tree_hash_packed_encoding()
}

fn tree_hash_packing_factor() -> usize {
u8::tree_hash_packing_factor()
<&u8>::tree_hash_packing_factor()
}

fn tree_hash_root(&self) -> Hash256 {
fn tree_hash_root(self) -> Hash256 {
int_to_hash256(*self as u64)
}
}

/// Only valid for byte types less than 32 bytes.
macro_rules! impl_for_lt_32byte_u8_array {
($len: expr) => {
impl TreeHash for [u8; $len] {
impl TreeHash for &[u8; $len] {
fn tree_hash_type() -> TreeHashType {
TreeHashType::Vector
}

fn tree_hash_packed_encoding(&self) -> PackedEncoding {
fn tree_hash_packed_encoding(self) -> PackedEncoding {
unreachable!("bytesN should never be packed.")
}

fn tree_hash_packing_factor() -> usize {
unreachable!("bytesN should never be packed.")
}

fn tree_hash_root(&self) -> Hash256 {
fn tree_hash_root(self) -> Hash256 {
let mut result = [0; 32];
result[0..$len].copy_from_slice(&self[..]);
Hash256::from_slice(&result)
Expand All @@ -83,68 +83,68 @@ macro_rules! impl_for_lt_32byte_u8_array {
impl_for_lt_32byte_u8_array!(4);
impl_for_lt_32byte_u8_array!(32);

impl TreeHash for [u8; 48] {
impl TreeHash for &[u8; 48] {
fn tree_hash_type() -> TreeHashType {
TreeHashType::Vector
}

fn tree_hash_packed_encoding(&self) -> PackedEncoding {
fn tree_hash_packed_encoding(self) -> PackedEncoding {
unreachable!("Vector should never be packed.")
}

fn tree_hash_packing_factor() -> usize {
unreachable!("Vector should never be packed.")
}

fn tree_hash_root(&self) -> Hash256 {
fn tree_hash_root(self) -> Hash256 {
let values_per_chunk = BYTES_PER_CHUNK;
let minimum_chunk_count = (48 + values_per_chunk - 1) / values_per_chunk;
merkle_root(self, minimum_chunk_count)
}
}

impl TreeHash for U128 {
impl TreeHash for &U128 {
fn tree_hash_type() -> TreeHashType {
TreeHashType::Basic
}

fn tree_hash_packed_encoding(&self) -> PackedEncoding {
PackedEncoding::from_slice(&self.to_le_bytes::<{ Self::BYTES }>())
fn tree_hash_packed_encoding(self) -> PackedEncoding {
PackedEncoding::from_slice(&self.to_le_bytes::<16>())
}

fn tree_hash_packing_factor() -> usize {
2
}

fn tree_hash_root(&self) -> Hash256 {
Hash256::right_padding_from(&self.to_le_bytes::<{ Self::BYTES }>())
fn tree_hash_root(self) -> Hash256 {
Hash256::right_padding_from(&self.to_le_bytes::<16>())
}
}

impl TreeHash for U256 {
impl TreeHash for &U256 {
fn tree_hash_type() -> TreeHashType {
TreeHashType::Basic
}

fn tree_hash_packed_encoding(&self) -> PackedEncoding {
PackedEncoding::from(self.to_le_bytes::<{ Self::BYTES }>())
fn tree_hash_packed_encoding(self) -> PackedEncoding {
PackedEncoding::from(self.to_le_bytes::<32>())
}

fn tree_hash_packing_factor() -> usize {
1
}

fn tree_hash_root(&self) -> Hash256 {
Hash256::from(self.to_le_bytes::<{ Self::BYTES }>())
fn tree_hash_root(self) -> Hash256 {
Hash256::from(self.to_le_bytes::<32>())
}
}

impl TreeHash for Address {
impl TreeHash for &Address {
fn tree_hash_type() -> TreeHashType {
TreeHashType::Vector
}

fn tree_hash_packed_encoding(&self) -> PackedEncoding {
fn tree_hash_packed_encoding(self) -> PackedEncoding {
let mut result = [0; 32];
result[0..20].copy_from_slice(self.as_slice());
PackedEncoding::from_slice(&result)
Expand All @@ -154,46 +154,49 @@ impl TreeHash for Address {
1
}

fn tree_hash_root(&self) -> Hash256 {
fn tree_hash_root(self) -> Hash256 {
let mut result = [0; 32];
result[0..20].copy_from_slice(self.as_slice());
Hash256::from_slice(&result)
}
}

impl TreeHash for B256 {
impl TreeHash for &B256 {
fn tree_hash_type() -> TreeHashType {
TreeHashType::Vector
}

fn tree_hash_packed_encoding(&self) -> PackedEncoding {
fn tree_hash_packed_encoding(self) -> PackedEncoding {
PackedEncoding::from_slice(self.as_slice())
}

fn tree_hash_packing_factor() -> usize {
1
}

fn tree_hash_root(&self) -> Hash256 {
fn tree_hash_root(self) -> Hash256 {
*self
}
}

impl<T: TreeHash> TreeHash for Arc<T> {
impl<'a, T> TreeHash for &'a Arc<T>
where
&'a T: TreeHash,
{
fn tree_hash_type() -> TreeHashType {
T::tree_hash_type()
<&T>::tree_hash_type()
}

fn tree_hash_packed_encoding(&self) -> PackedEncoding {
self.as_ref().tree_hash_packed_encoding()
fn tree_hash_packed_encoding(self) -> PackedEncoding {
Arc::as_ref(self).tree_hash_packed_encoding()
}

fn tree_hash_packing_factor() -> usize {
T::tree_hash_packing_factor()
<&T>::tree_hash_packing_factor()
}

fn tree_hash_root(&self) -> Hash256 {
self.as_ref().tree_hash_root()
fn tree_hash_root(self) -> Hash256 {
Arc::as_ref(self).tree_hash_root()
}
}

Expand Down
38 changes: 8 additions & 30 deletions tree_hash/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,52 +112,30 @@ pub enum TreeHashType {
pub trait TreeHash {
fn tree_hash_type() -> TreeHashType;

fn tree_hash_packed_encoding(&self) -> PackedEncoding;
fn tree_hash_packed_encoding(self) -> PackedEncoding;

fn tree_hash_packing_factor() -> usize;

fn tree_hash_root(&self) -> Hash256;
}

/// Punch through references.
impl<'a, T> TreeHash for &'a T
where
T: TreeHash,
{
fn tree_hash_type() -> TreeHashType {
T::tree_hash_type()
}

fn tree_hash_packed_encoding(&self) -> PackedEncoding {
T::tree_hash_packed_encoding(*self)
}

fn tree_hash_packing_factor() -> usize {
T::tree_hash_packing_factor()
}

fn tree_hash_root(&self) -> Hash256 {
T::tree_hash_root(*self)
}
fn tree_hash_root(self) -> Hash256;
}

#[macro_export]
macro_rules! tree_hash_ssz_encoding_as_vector {
($type: ident) => {
impl tree_hash::TreeHash for $type {
impl tree_hash::TreeHash for &$type {
fn tree_hash_type() -> tree_hash::TreeHashType {
tree_hash::TreeHashType::Vector
}

fn tree_hash_packed_encoding(&self) -> PackedEncoding {
fn tree_hash_packed_encoding(self) -> PackedEncoding {
unreachable!("Vector should never be packed.")
}

fn tree_hash_packing_factor() -> usize {
unreachable!("Vector should never be packed.")
}

fn tree_hash_root(&self) -> Vec<u8> {
fn tree_hash_root(self) -> Vec<u8> {
tree_hash::merkle_root(&ssz::ssz_encode(self))
}
}
Expand All @@ -167,20 +145,20 @@ macro_rules! tree_hash_ssz_encoding_as_vector {
#[macro_export]
macro_rules! tree_hash_ssz_encoding_as_list {
($type: ident) => {
impl tree_hash::TreeHash for $type {
impl tree_hash::TreeHash for &$type {
fn tree_hash_type() -> tree_hash::TreeHashType {
tree_hash::TreeHashType::List
}

fn tree_hash_packed_encoding(&self) -> PackedEncoding {
fn tree_hash_packed_encoding(self) -> PackedEncoding {
unreachable!("List should never be packed.")
}

fn tree_hash_packing_factor() -> usize {
unreachable!("List should never be packed.")
}

fn tree_hash_root(&self) -> Vec<u8> {
fn tree_hash_root(self) -> Vec<u8> {
ssz::ssz_encode(self).tree_hash_root()
}
}
Expand Down
6 changes: 3 additions & 3 deletions tree_hash/tests/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,20 @@ impl From<Vec<u8>> for HashVec {
}
}

impl tree_hash::TreeHash for HashVec {
impl tree_hash::TreeHash for &HashVec {
fn tree_hash_type() -> tree_hash::TreeHashType {
tree_hash::TreeHashType::List
}

fn tree_hash_packed_encoding(&self) -> PackedEncoding {
fn tree_hash_packed_encoding(self) -> PackedEncoding {
unreachable!("List should never be packed.")
}

fn tree_hash_packing_factor() -> usize {
unreachable!("List should never be packed.")
}

fn tree_hash_root(&self) -> Hash256 {
fn tree_hash_root(self) -> Hash256 {
let mut hasher =
MerkleHasher::with_leaves((self.vec.len() + BYTES_PER_CHUNK - 1) / BYTES_PER_CHUNK);

Expand Down
Loading