Skip to content

Commit 6d2f40f

Browse files
committed
Update abstract, remove tokio feat
1 parent 48139cb commit 6d2f40f

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

nym-vpn-core/crates/nym-vpn-lib-types/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ thiserror.workspace = true
4040
ts-rs = { workspace = true, optional = true }
4141
zeroize.workspace = true
4242
ipnetwork = { workspace = true, optional = true }
43-
uniffi = { workspace = true, features = ["tokio"], optional = true }
43+
uniffi = { workspace = true, optional = true }
4444

4545
nym-registration-common = { workspace = true, optional = true }
4646
nym-crypto = { workspace = true, features = ["asymmetric"] }

nym-vpn-core/crates/nym-vpn-lib-types/src/lib.rs

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,19 @@
33

44
//! Types shared between nym-vpn-lib and other crates in the workspace.
55
//!
6+
//! ## Abstract
7+
//!
8+
//! - This crate contains all types necessary for interaction with nym-vpn-lib and daemon.
9+
//! - Please do not re-export types from other crates, instead define them here.
10+
//! When mirroring external types, consider providing `From` implementations for easier conversions. Feature-gate conversions to `nym-type-conversions`.
11+
//! - Types visible via bindings should contain proper attributes and feature gated to `uniffi-bindings` for uniffi, `typescript-bindings` for TypeScript bindings.
12+
//! - TypeScript bindings use serde for conversion from Rust to TS and feature-gated to `typescript-bindings`. Camel case is preferred for compatibility with TypeScript/Tauri.
13+
//! - Be mindful of limitations of TypeScript and uniffi limitations. Keep exported types simple.
14+
//!
15+
//! ## Dependency considerations
16+
//!
17+
//! Please keep direct dependencies to other crates to a minimum to avoid dependency conflicts which can happen, especially when using it in other large projects such as Tauri.
18+
619
//! ## Supported bindings
720
//!
821
//! 1. [uniffi](https://mozilla.github.io/uniffi-rs/latest/) bindings (feature flag: uniffi-bindings). The following limitations apply:

0 commit comments

Comments
 (0)