mod.rs 4.53 KB
Newer Older
1
// Copyright 2018-2021 Parity Technologies (UK) Ltd.
2
3
4
5
6
7
8
9
10
11
12
13
14
//
// 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.

15
use crate::traits::ExtKeyPtr as _;
16

17
18
19
macro_rules! impl_always_packed_layout {
    ( $name:ident < $($frag:ident),+ >, deep: $deep:expr ) => {
        const _: () = {
20
            use crate::traits::impls::{
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
                forward_clear_packed,
                forward_pull_packed,
                forward_push_packed,
            };
            impl<$($frag),+> SpreadLayout for $name < $($frag),+ >
            where
                $(
                    $frag: PackedLayout,
                )+
            {
                const FOOTPRINT: u64 = 1;

                const REQUIRES_DEEP_CLEAN_UP: bool = $deep;

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

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

                #[inline]
                fn clear_spread(&self, ptr: &mut KeyPtr) {
                    forward_clear_packed::<Self>(self, ptr)
                }
            }
        };
    };
    ( $name:ty, deep: $deep:expr ) => {
        const _: () = {
54
            use crate::traits::impls::{
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
                forward_clear_packed,
                forward_pull_packed,
                forward_push_packed,
            };
            impl SpreadLayout for $name
            where
                Self: PackedLayout,
            {
                const FOOTPRINT: u64 = 1;

                const REQUIRES_DEEP_CLEAN_UP: bool = $deep;

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

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

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

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

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

94
95
96
97
98
99
use super::{
    clear_packed_root,
    pull_packed_root,
    push_packed_root,
    PackedLayout,
};
100
use crate::traits::KeyPtr;
101
102
103
104
105
106
107
108
109
110
111
112
113
114

/// 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
115
/// instead of a spread storage layout pull operation.
116
117
118
119
120
#[inline]
pub fn forward_pull_packed<T>(ptr: &mut KeyPtr) -> T
where
    T: PackedLayout,
{
121
    pull_packed_root::<T>(ptr.next_for::<T>())
122
123
124
125
126
127
128
129
130
131
}

/// 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
132
/// instead of a spread storage layout push operation.
133
134
135
136
137
#[inline]
pub fn forward_push_packed<T>(entity: &T, ptr: &mut KeyPtr)
where
    T: PackedLayout,
{
138
    push_packed_root::<T>(entity, ptr.next_for::<T>())
139
140
141
142
143
144
145
146
147
148
}

/// 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
149
/// instead of a spread storage layout clear operation.
150
151
152
153
154
#[inline]
pub fn forward_clear_packed<T>(entity: &T, ptr: &mut KeyPtr)
where
    T: PackedLayout,
{
155
    clear_packed_root::<T>(entity, ptr.next_for::<T>())
156
}