lib.rs 1.86 KB
Newer Older
1
// Copyright 2018-2020 Parity Technologies (UK) Ltd.
2
//
3
4
5
// 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
6
//
7
//     http://www.apache.org/licenses/LICENSE-2.0
8
//
9
10
11
12
13
// 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.
14

15
//! The `ink_storage` utilities used to manipulate and organize contract storage.
Hero Bird's avatar
Hero Bird committed
16
17
18
19
20
21
22
//!
//! Mainly provides entities to work on a contract's storage
//! as well as high-level collections on top of those.
//! Also provides environmental utilities, such as storage allocators,
//! FFI to interface with SRML contracts and a primitive blockchain
//! emulator for simple off-chain testing.

23
#![cfg_attr(not(feature = "std"), no_std)]
24
#![deny(
25
    missing_docs,
26
    bad_style,
27
    bare_trait_objects,
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
    const_err,
    improper_ctypes,
    non_shorthand_field_patterns,
    no_mangle_generic_items,
    overflowing_literals,
    path_statements,
    patterns_in_fns_without_body,
    private_in_public,
    unconditional_recursion,
    unused_allocation,
    unused_comparisons,
    unused_parens,
    while_true,
    trivial_casts,
    trivial_numeric_casts,
    unused_extern_crates
44
)]
45

46
47
48
49
#[cfg(all(test, feature = "std", feature = "ink-fuzz-tests"))]
#[macro_use(quickcheck)]
extern crate quickcheck_macros;

50
51
52
53
54
55
56
57
58
59
pub mod alloc;
pub mod collections;
pub mod lazy;
mod memory;
mod pack;
pub mod traits;

#[cfg(test)]
mod hashmap_entry_api_tests;

60
61
62
#[cfg(test)]
mod test_utils;

63
64
65
66
67
68
69
70
#[doc(inline)]
pub use self::{
    alloc::Box,
    collections::Vec,
    lazy::Lazy,
    memory::Memory,
    pack::Pack,
};