ink_storage_traits/layout/
mod.rs

1// Copyright (C) Use Ink (UK) Ltd.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15mod impls;
16
17use ink_metadata::layout::Layout;
18use ink_primitives::Key;
19
20/// Implemented by types that have a storage layout.
21pub trait StorageLayout {
22    /// Returns the static storage layout of `Self`.
23    ///
24    /// The given storage key is guiding the allocation of static fields onto
25    /// the contract storage regions.
26    fn layout(key: &Key) -> Layout;
27}