85 lines
2.5 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
//! `#[fce]` that could be applied to a function, structure or extern block.
2019-10-07 14:01:20 +03:00
//!
2020-07-28 18:44:24 +03:00
//! Structures with `#[fce]` (hereinafter they'll be called records) could be used then in function
//! 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 fluence::fce;
//!
//! #[fce]
//! 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
//! }
//! ```
//!
//! Functions with `#[fce]` will be exported from this module:
//!
//! ```rust
//! use fluence::fce;
//!
//! #[fce]
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 fluence::fce;
//!
//! #[fce]
//! #[link(wasm_import_module = "wasm_curl.wasm")]
//! extern "C" {
//! #[link_name = "get"]
//! pub fn curl_get(url: String) -> String;
//! }
//! ```
2020-10-01 12:27:37 +03:00
#![doc(html_root_url = "https://docs.rs/fluence/0.2.8")]
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
2020-07-05 22:46:23 +03:00
pub use fluence_sdk_macro::fce;
2020-08-22 00:07:57 +03:00
pub use fluence_sdk_main::CallParameters;
2020-08-24 20:50:03 +03:00
#[cfg(target_arch = "wasm32")]
2020-08-22 00:07:57 +03:00
pub use fluence_sdk_main::get_call_parameters;
2020-07-14 19:01:17 +03:00
#[cfg(feature = "logger")]
pub use fluence_sdk_main::WasmLogger;
/// These API functions are intended for internal usage in generated code.
/// Normally, you shouldn't use them.
pub mod internal {
pub use fluence_sdk_main::get_result_ptr;
pub use fluence_sdk_main::get_result_size;
pub use fluence_sdk_main::set_result_ptr;
pub use fluence_sdk_main::set_result_size;
}