concordium_base 10.0.0-alpha.0

A library that defines common types and functionality that are needed by Concordium Rust projects.
Documentation 
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

//! Common types and operations used throughout the Concordium chain
//! development.
pub mod cbor;
mod encoded;
#[cfg(test)]
mod helpers;
mod impls;
mod serde_impls;
mod serialize;
pub mod types;
mod version;

pub use encoded::*;

#[cfg(test)]
pub use self::helpers::serialize_deserialize;
pub use self::{serialize::*, version::*};

// Reexport for ease of use.
pub use byteorder::{ReadBytesExt, WriteBytesExt};

/// Derive macro to derive [serde::Deserialize] instances.
pub use serde::Deserialize as SerdeDeserialize;
/// Derive macro to derive [serde::Serialize] instances.
pub use serde::Serialize as SerdeSerialize;

/// These are re-exported to help the derive crate.
/// The derive crate uses these so that users don't have to explicitly
/// import `serde::Deserializer` and `serde::Serializer` in their modules
/// when deriving serialization implementations using the
/// `concordium_base_derive` crate.
#[doc(hidden)]
pub use serde::Deserializer as SerdeDeserializer;
#[doc(hidden)]
pub use serde::Serializer as SerdeSerializer;

pub use concordium_base_derive::*;

#[doc(hidden)]
/// This is provided as a workaround so that we can build these libraries in
/// Wasm. FIXME: At some point we should handle this better. The FFI exports are
/// mostly not needed in Wasm, and they are the only ones that need this.
#[cfg(not(target_arch = "wasm32"))]
pub use libc::size_t;
#[cfg(target_arch = "wasm32")]
#[allow(non_camel_case_types)]
pub type size_t = usize;

#[cfg(feature = "encryption")]
/// Module that provides a simple API for symmetric encryption in the output
/// formats used by Concordium.
pub mod encryption;
pub mod upward;