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
// 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.
use super::{
spread::SpreadAllocate,
SpreadLayout,
};
use ink_primitives::Key;
/// Types that can be default initialized to a single storage cell.
pub trait PackedAllocate: SpreadAllocate + PackedLayout {
/// Indicates to `self` that is has just been allocated to the storage.
///
/// # Note
///
/// Most types will have to implement a trivial forwarding to their fields.
fn allocate_packed(&mut self, at: &Key);
}
/// Types that can be stored to and loaded from a single contract storage cell.
pub trait PackedLayout: SpreadLayout + scale::Encode + scale::Decode {
/// Indicates to `self` that is has just been pulled from the storage.
///
/// # Note
///
/// Most types will have to implement a trivial forwarding to their fields.
fn pull_packed(&mut self, at: &Key);
/// Indicates to `self` that it is about to be pushed to contract storage.
///
/// # Note
///
/// Most types will have to implement a trivial forwarding to their fields.
fn push_packed(&self, at: &Key);
/// Indicates to `self` that it is about to be cleared from contract storage.
///
/// # Note
///
/// Most types will have to implement a trivial forwarding to their fields.
fn clear_packed(&self, at: &Key);
}