lo/libsoliton
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Update API Reference

kamal 2026-04-03 19:44:50 +00:00
commit 5a86b7dd3d
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
API-Reference.md

@ -99,7 +99,7 @@ Quick reference for the soliton v1 API. For the full cryptographic specification
libsoliton = { path = "../soliton" } libsoliton = { path = "../soliton" }
# Published form (once on crates.io — use one or the other, not both): # Published form (once on crates.io — use one or the other, not both):
# libsoliton = "0.1.0" # libsoliton = "0.1.1"
``` ```
**Minimum toolchain: Rust 1.93 (edition 2024).** The `unsafe extern "C" {}` block syntax added in edition 2024 is required; older toolchains produce cryptic parse errors. Run `rustup update stable` to get a recent toolchain. **Minimum toolchain: Rust 1.93 (edition 2024).** The `unsafe extern "C" {}` block syntax added in edition 2024 is required; older toolchains produce cryptic parse errors. Run `rustup update stable` to get a recent toolchain.
@ -2022,7 +2022,7 @@ pub fn aead_decrypt(key: &[u8; 32], nonce: &[u8; 24],
### C API ### C API
```c ```c
// Returns the library version string — the Cargo crate semver (e.g., "0.1.0"), // Returns the library version string — the Cargo crate semver (e.g., "0.1.1"),
// not the spec revision. Static lifetime, null-terminated. Caller must NOT free. // not the spec revision. Static lifetime, null-terminated. Caller must NOT free.
// Rust equivalent: soliton::VERSION (&str, same value). // Rust equivalent: soliton::VERSION (&str, same value).
const char *soliton_version(void); const char *soliton_version(void);