ink_storage_traits/
lib.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
15//! Traits and interfaces to operate with storage entities.
16//!
17//! Generally a type is said to be a storage entity if it implements the
18//! [`Storable`] trait. This defines certain constants and routines in order
19//! to tell a smart contract how to load and store instances of this type
20//! from and to the contract's storage.
21//!
22//! The [`Packed`] shows that the type can be stored into single storage cell.
23//! In most cases, collections(`Vec`, `HashMap`, `HashSet` etc.) work only with packed
24//! structures.
25//!
26//! If at least one of the type's fields occupies its own separate storage cell, it is a
27//! non-[`Packed`] type because it occupies more than one storage cell.
28
29#![doc(
30    html_logo_url = "https://use.ink/img/crate-docs/logo.png",
31    html_favicon_url = "https://use.ink/crate-docs/favicon.png"
32)]
33#![cfg_attr(not(feature = "std"), no_std)]
34
35mod impls;
36mod storage;
37
38#[cfg(feature = "std")]
39mod layout;
40
41#[cfg(feature = "std")]
42pub use self::layout::StorageLayout;
43pub use self::{
44    impls::{
45        AutoKey,
46        ManualKey,
47        ResolverKey,
48    },
49    storage::{
50        decode_all,
51        AutoStorableHint,
52        Packed,
53        Storable,
54        StorableHint,
55        StorageKey,
56    },
57};
ink_storage_traits/lib.rs

ink_storage_traits/
lib.rs
