github/extism
1
1
Fork 0
mirror of https://github.com/extism/extism.git synced 2026-01-09 13:57:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add readme, bump convert crate (#495)

Browse Source 
Co-authored-by: zach <zach@dylibso.com>
This commit is contained in:
Benjamin Eckel
2023-10-04 16:33:54 -05:00
committed by GitHub
parent e7ffc1dd6b
commit bc56d7303a
4 changed files with 16 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
convert/Cargo.toml
View File

@@ -1,9 +1,10 @@
[package]
name = "extism-convert"
version = "0.1.0"
version = "0.2.0"
edition = "2021"
authors = ["The Extism Authors", "oss@extism.org"]
license = "BSD-3-Clause"
readme = "./README.md"
homepage = "https://extism.org"
repository = "https://github.com/extism/extism"
description = "Traits to make Rust types usable with Extism"

12
convert/README.md Normal file
View File

@@ -0,0 +1,12 @@
# extism-convert
The [extism-convert](https://crates.io/crates/extism-convert) crate is used by the [Rust SDK](https://crates.io/crates/extism) and [Rust PDK](https://crates.io/crates/extism-pdk) to provide a shared interface for
encoding and decoding values that can be passed to Extism function calls.
A set of types (Json, Msgpack, Protobuf) that can be used to specify a serde encoding are also provided. These are
similar to [axum extractors](https://docs.rs/axum/latest/axum/extract/index.html#intro) - they are
implemented as a tuple struct with a single field that is meant to be extracted using pattern matching.
## Documentation
See [extism-convert on docs.rs](https://docs.rs/extism-convert/latest/extism_convert/) for in-depth documentation.

2
convert/src/lib.rs
View File

@@ -1,4 +1,4 @@
//! The `extism-convert` crate is used by the SDK and PDK to provide a shared interface for
//! The [extism-convert](https://crates.io/crates/extism-convert) crate is used by the [Rust SDK](https://crates.io/crates/extism) and [Rust PDK](https://crates.io/crates/extism-pdk) to provide a shared interface for
//! encoding and decoding values that can be passed to Extism function calls.
//!
//! A set of types (Json, Msgpack) that can be used to specify a serde encoding are also provided. These are