128 lines
4.0 KiB
Rust
Raw Normal View History

2019-10-07 14:01:20 +03:00
/*
* Copyright 2020 Fluence Labs Limited
2019-10-07 14:01:20 +03:00
*
* 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
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
2020-07-28 17:50:04 +03:00
//! Rust backend SDK for applications on the Fluence network. This crate defines the procedure macro
2021-05-10 13:50:52 +03:00
//! `#[marine]` that could be applied to a function, structure or extern block.
2019-10-07 14:01:20 +03:00
//!
2021-05-10 13:50:52 +03:00
//! Structures with `#[marine]` (hereinafter they'll be called records) could be used then in function
2020-07-28 18:44:24 +03:00
//! arguments and values. All fields of a record should be public and have one of the
2020-07-28 17:50:04 +03:00
//! following primitive Rust types
//! (`bool, u8, u16, u32, u64, i8, i16, i32, i64, f32, f64, String, Vec<u8>`).
//! ```rust
//! use marine_rs_sdk::marine;
2020-07-28 17:50:04 +03:00
//!
2021-05-10 13:50:52 +03:00
//! #[marine]
2020-07-28 17:50:04 +03:00
//! struct T {
2020-07-28 18:44:24 +03:00
//! pub field_1: i32,
//! pub field_2: Vec<u8>,
2020-07-28 17:50:04 +03:00
//! }
//! ```
//!
2021-05-10 13:50:52 +03:00
//! Functions with `#[marine]` will be exported from this module:
2020-07-28 17:50:04 +03:00
//!
//! ```rust
//! use marine_rs_sdk::marine;
2020-07-28 17:50:04 +03:00
//!
2021-05-10 13:50:52 +03:00
//! #[marine]
2020-07-28 19:35:36 +03:00
//! pub fn get(url: String) {
//! // ...
2020-07-28 17:50:04 +03:00
//! }
//! ```
//! At now, such functions could have arguments with primitive Rust types and record and only one
//! return argument with such type could be used.
//!
//! Finally, to import other wasm modules to your project use similar code:
//! ```rust
//! use marine_rs_sdk::marine;
2020-07-28 17:50:04 +03:00
//!
2021-05-10 13:50:52 +03:00
//! #[marine]
2020-07-28 17:50:04 +03:00
//! #[link(wasm_import_module = "wasm_curl.wasm")]
//! extern "C" {
//! #[link_name = "get"]
//! pub fn curl_get(url: String) -> String;
//! }
//! ```
#![doc(html_root_url = "https://docs.rs/sdk/0.12.0")] // x-release-please-version
2019-10-07 14:01:20 +03:00
#![deny(
dead_code,
nonstandard_style,
unused_imports,
unused_mut,
unused_variables,
unused_unsafe,
unreachable_patterns
)]
#![warn(rust_2018_idioms)]
2019-10-07 14:01:20 +03:00
2021-03-09 15:45:05 +03:00
mod mounted_binary;
2021-04-04 23:25:42 +03:00
#[allow(unused_extern_crates)]
// sdk is used inside CallParameters and MountedBinaryResult glue code
extern crate self as marine_rs_sdk;
2021-03-09 15:45:05 +03:00
2021-05-10 12:23:26 +03:00
pub use marine_macro::marine;
2021-05-10 13:57:10 +03:00
pub use marine_macro::fce;
2020-10-29 14:10:50 +03:00
pub use marine_call_parameters::CallParameters;
pub use marine_call_parameters::ParticleParameters;
pub use marine_call_parameters::SecurityTetraplet;
pub use marine_call_parameters::get_call_parameters;
2020-10-29 14:10:50 +03:00
2020-07-14 19:01:17 +03:00
#[cfg(feature = "logger")]
pub use marine_rs_sdk_main::WasmLoggerBuilder;
2020-10-29 14:10:50 +03:00
#[cfg(feature = "logger")]
pub use marine_rs_sdk_main::TargetMap;
2021-04-05 12:38:28 +03:00
pub use mounted_binary::MountedBinaryResult;
pub use mounted_binary::MountedBinaryStringResult;
2021-03-09 15:45:05 +03:00
pub use mounted_binary::SUCCESS_CODE as BINARY_SUCCESS_CODE;
2021-02-19 17:14:50 +03:00
pub use marine_rs_sdk_main::module_manifest;
2021-03-11 13:58:29 +03:00
/// These API functions are intended for internal usage in generated code.
/// Normally, you shouldn't use them.
#[cfg(all(feature = "marine-abi", target_arch = "wasm32"))]
2021-09-28 15:44:12 +03:00
#[doc(hidden)]
pub mod internal {
pub use marine_rs_sdk_main::get_result_ptr;
pub use marine_rs_sdk_main::get_result_size;
pub use marine_rs_sdk_main::set_result_ptr;
pub use marine_rs_sdk_main::set_result_size;
pub use marine_rs_sdk_main::add_object_to_release;
2021-05-10 12:23:26 +03:00
pub use marine_timestamp_macro::build_timestamp;
}
#[cfg(not(feature = "no-explicit-ctors-call"))]
#[cfg(all(feature = "marine-abi", target_arch = "wasm32"))]
extern "C" {
// For internal use. Not an API function.
fn __wasm_call_ctors();
}
// Adds an explicit __wasm_call_ctors call to tell LLVM not to
// wrap every export in __wasm_call_ctors/__wasm_call_dtors calls.
// The most referenced issue about it is https://github.com/WebAssembly/WASI/issues/471
// For internal use. Not an API function.
#[cfg(not(feature = "no-explicit-ctors-call"))]
#[cfg(all(feature = "marine-abi", target_arch = "wasm32"))]
#[doc(hidden)]
#[no_mangle]
pub fn _initialize() {
unsafe {
__wasm_call_ctors();
}
}