mod.rs

// Copyright 2018-2022 Parity Technologies (UK) Ltd.
//
// 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.

macro_rules! impl_always_packed_layout {
    ( $name:ident < $($frag:ident),+ >, deep: $deep:expr ) => {
        impl<$($frag),+> $crate::traits::SpreadLayout for $name < $($frag),+ >
        where
            $(
                $frag: $crate::traits::PackedLayout,
            )+
        {
            const FOOTPRINT: ::core::primitive::u64 = 1_u64;
            const REQUIRES_DEEP_CLEAN_UP: ::core::primitive::bool = $deep;

            #[inline]
            fn pull_spread(ptr: &mut $crate::traits::KeyPtr) -> Self {
                $crate::traits::impls::forward_pull_packed::<Self>(ptr)
            }

            #[inline]
            fn push_spread(&self, ptr: &mut $crate::traits::KeyPtr) {
                $crate::traits::impls::forward_push_packed::<Self>(self, ptr)
            }

            #[inline]
            fn clear_spread(&self, ptr: &mut $crate::traits::KeyPtr) {
                $crate::traits::impls::forward_clear_packed::<Self>(self, ptr)
            }
        }

        impl<$($frag),+> $crate::traits::SpreadAllocate for $name < $($frag),+ >
        where
            Self: ::core::default::Default,
            $(
                $frag: $crate::traits::PackedAllocate,
            )+
        {
            #[inline]
            fn allocate_spread(ptr: &mut $crate::traits::KeyPtr) -> Self {
                $crate::traits::impls::forward_allocate_packed::<Self>(ptr)
            }
        }
    };
    ( $name:ty, deep: $deep:expr ) => {
        impl $crate::traits::SpreadLayout for $name
        where
            Self: $crate::traits::PackedLayout,
        {
            const FOOTPRINT: ::core::primitive::u64 = 1_u64;
            const REQUIRES_DEEP_CLEAN_UP: ::core::primitive::bool = $deep;

            #[inline]
            fn pull_spread(ptr: &mut $crate::traits::KeyPtr) -> Self {
                $crate::traits::impls::forward_pull_packed::<Self>(ptr)
            }

            #[inline]
            fn push_spread(&self, ptr: &mut $crate::traits::KeyPtr) {
                $crate::traits::impls::forward_push_packed::<Self>(self, ptr)
            }

            #[inline]
            fn clear_spread(&self, ptr: &mut $crate::traits::KeyPtr) {
                $crate::traits::impls::forward_clear_packed::<Self>(self, ptr)
            }
        }

        impl $crate::traits::SpreadAllocate for $name
        where
            Self: $crate::traits::PackedLayout + ::core::default::Default,
        {
            #[inline]
            fn allocate_spread(ptr: &mut $crate::traits::KeyPtr) -> Self {
                $crate::traits::impls::forward_allocate_packed::<Self>(ptr)
            }
        }
    };
}

mod arrays;
mod collections;
mod prims;
mod tuples;

#[cfg(all(test, feature = "ink-fuzz-tests"))]
mod fuzz_tests;

use super::{
    allocate_packed_root,
    clear_packed_root,
    pull_packed_root,
    push_packed_root,
    PackedAllocate,
    PackedLayout,
};
use crate::traits::{
    ExtKeyPtr as _,
    KeyPtr,
};

/// Returns the greater of both values.
const fn max(a: u64, b: u64) -> u64 {
    [a, b][(a > b) as usize]
}

/// Pulls an instance of type `T` in packed fashion from the contract storage.
///
/// Loads the instance from the storage location identified by `ptr`.
/// The storage entity is expected to be decodable in its packed form.
///
/// # Note
///
/// Use this utility function to use a packed pull operation for the type
/// instead of a spread storage layout pull operation.
#[inline]
pub fn forward_pull_packed<T>(ptr: &mut KeyPtr) -> T
where
    T: PackedLayout,
{
    pull_packed_root::<T>(ptr.next_for::<T>())
}

/// Allocates an instance of type `T` in packed fashion to the contract storage.
///
/// This default initializes the entity at the storage location identified
/// by `ptr`. The storage entity is expected to be decodable in its packed form.
///
/// # Note
///
/// Use this utility function to use a packed allocate operation for the type
/// instead of a spread storage layout allocation operation.
#[inline]
pub fn forward_allocate_packed<T>(ptr: &mut KeyPtr) -> T
where
    T: PackedAllocate + Default,
{
    allocate_packed_root::<T>(ptr.next_for::<T>())
}

/// Pushes an instance of type `T` in packed fashion to the contract storage.
///
/// Stores the instance to the storage location identified by `ptr`.
/// The storage entity is expected to be encodable in its packed form.
///
/// # Note
///
/// Use this utility function to use a packed push operation for the type
/// instead of a spread storage layout push operation.
#[inline]
pub fn forward_push_packed<T>(entity: &T, ptr: &mut KeyPtr)
where
    T: PackedLayout,
{
    push_packed_root::<T>(entity, ptr.next_for::<T>());
}

/// Clears an instance of type `T` in packed fashion from the contract storage.
///
/// Clears the instance from the storage location identified by `ptr`.
/// The cleared storage entity is expected to be encoded in its packed form.
///
/// # Note
///
/// Use this utility function to use a packed clear operation for the type
/// instead of a spread storage layout clear operation.
#[inline]
pub fn forward_clear_packed<T>(entity: &T, ptr: &mut KeyPtr)
where
    T: PackedLayout,
{
    clear_packed_root::<T>(entity, ptr.next_for::<T>())
}