Skip to main content

ic_dbms_api/
lib.rs

1#![crate_name = "ic_dbms_api"]
2#![crate_type = "lib"]
3#![cfg_attr(docsrs, feature(doc_cfg))]
4#![deny(clippy::print_stdout)]
5#![deny(clippy::print_stderr)]
6
7//! # IC DBMS API
8//!
9//! IC-specific API types for ic-dbms-canister.
10//!
11//! This crate re-exports all generic types from [`wasm_dbms_api`] and adds
12//! IC-specific types such as [`Principal`](crate::prelude::Principal) and
13//! canister init arguments.
14//!
15//! Import all useful types and traits via the prelude:
16//!
17//! ```rust
18//! use ic_dbms_api::prelude::*;
19//! ```
20
21#![doc(html_playground_url = "https://play.rust-lang.org")]
22#![doc(
23    html_favicon_url = "https://raw.githubusercontent.com/veeso/wasm-dbms/main/assets/images/cargo/logo-128.png"
24)]
25#![doc(
26    html_logo_url = "https://raw.githubusercontent.com/veeso/wasm-dbms/main/assets/images/cargo/logo-512.png"
27)]
28
29// Makes the crate accessible as `ic_dbms_api` in macros.
30extern crate self as ic_dbms_api;
31
32// Re-export generic modules from wasm-dbms-api for path compatibility.
33pub use wasm_dbms_api::{dbms, memory, utils};
34
35mod error;
36mod init;
37pub mod prelude;
38mod principal;
39#[cfg(test)]
40mod tests;