fluencelabs/marine
1
0
Fork 0
mirror of https://github.com/fluencelabs/marine.git synced 2024-12-12 06:45:32 +00:00
Code Issues Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
vms 2020-10-01 12:23:29 +03:00
parent 444e30749e
commit 31797d4c13
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -15,7 +15,7 @@ this will add `fce` binary to your system.
### Recommendations: ### Recommendations:
- Modules architecture should be upwards from `effectors` (modules that persist data and WASI modules) that will work with local binaries, local storage and syscalls to `pure modules` that perform business logic. - Modules architecture should be upwards from `effectors` (modules that persist data and WASI modules) that will work with local binaries, local storage and syscalls to `pure modules` that perform business logic.
- Splitting app to small FCE modules are easier to support, reuse and distribute - Split app to small FCE modules are easier to support, reuse and distribute
- Each module for its own task (npm like) - Each module for its own task (npm like)
### Module project structure ### Module project structure
@ -44,7 +44,7 @@ pub fn get(url: String) -> String {
``` ```
- Multiple arguments with primitive Rust types (`bool, u8, u16, u32, u64, i8, i16, i32, i64, f32, f64, String, Vec<u8>`) and only one return argument could be used - Multiple arguments with primitive Rust types (`bool, u8, u16, u32, u64, i8, i16, i32, i64, f32, f64, String, Vec<u8>`) and only one return argument could be used
- Build project with `fce build` (supports --release and all other cargo flags now) - Build project with `fce build` (supports --release and all other cargo flags as usual)
- Copy wasm file from `target/wasm32-wasi/debug` or `target/wasm32-wasi/release` to directory with other modules - Copy wasm file from `target/wasm32-wasi/debug` or `target/wasm32-wasi/release` to directory with other modules
@ -84,15 +84,16 @@ modules_dir = "wasm/artifacts/modules/"
name = "curl" name = "curl"
logger_enabled = true logger_enabled = true
[module.imports] [module.mounted_binaries]
curl = "/usr/bin/curl" curl = "/usr/bin/curl"
[[module]] [[module]]
name = "site-storage" name = "site-storage"
mem_pages_count = 10000 mem_pages_count = 10000
logger_enabled = true logger_enabled = true
[module.wasi] [module.wasi]
envs = ["ENV_ONE=parameter-one"] envs = { "ENV_ONE" = "parameter-one" }
``` ```
`modules_dir` - path to directory with all modules. All subsequent paths will be relative to this path `modules_dir` - path to directory with all modules. All subsequent paths will be relative to this path
@ -103,7 +104,7 @@ modules_dir = "wasm/artifacts/modules/"
`mem_pages_count` - a maximum number of Wasm memory pages that loaded module can use. Each Wasm pages is 65536 bytes long `mem_pages_count` - a maximum number of Wasm memory pages that loaded module can use. Each Wasm pages is 65536 bytes long
`[module.imports]` - list of available imports `[module.mounted_binaries]` - list of mounted binary executable files
`curl = "/usr/bin/curl"` - gives possibility to call binary file `/usr/bin/curl` as method `curl` in Rust code `curl = "/usr/bin/curl"` - gives possibility to call binary file `/usr/bin/curl` as method `curl` in Rust code
@ -127,4 +128,4 @@ Working with files as usual:
```rust ```rust
fs::write(PathBuf::from("/tmp/somefile"), vec!(1,2,3)); fs::write(PathBuf::from("/tmp/somefile"), vec!(1,2,3));
fs::read(...); fs::read(...);
``` ```