Crate nym_bridges_types 

Minimal compatible Types shared between nym-bridges and other crates.

Abstract

• This crate contains all types necessary for interaction with crates (nym-vpn-lib-types) and others
• Types visible via bindings should contain proper attributes and feature gated to uniffi-bindings for uniffi, typescript-bindings for TypeScript bindings.
• TypeScript bindings use serde for conversion from Rust to TS and feature-gated to typescript-bindings.
• Be mindful of limitations of TypeScript and uniffi limitations. Keep exported types simple.

Dependency considerations

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.

Supported bindings

1. uniffi bindings (feature flag: uniffi-bindings). The following limitations apply:

• Namespaces are not supported, all exported types should have unique names.
• Not all types are supported or can be bridged. Keep exported types simple.

2. TypeScript bindings using ts-rs (feature flag: typescript-bindings). Serialization (using serde) uses snake_case.

   Run the following command to generate TypeScript bindings:

   cargo test -p nym-vpn-lib-types -F typescript-bindings

Serde support

Serde can be enabled using serde feature flag.

Modules

quic

ssh

tls

Structs

PersistedClientConfig

Enums

ClientConfig

Traits

Sufficiency

Whether this transport has sufficient details to dial: at least one address and a non-blank identity pin (the pin is what the certificate is verified against, so a transport without one is unusable regardless of addresses). Callers picking “any advertised transport” should filter on this — see PersistedClientConfig::usable_transports.

TransportAssociation

Trait allowing types to indicate the name of the transport type with which they are associated.