diff options
| author | Bug Magnet <marco.nikic@mullvad.net> | 2024-11-11 10:06:14 +0100 |
|---|---|---|
| committer | Bug Magnet <marco.nikic@mullvad.net> | 2024-11-26 11:03:54 +0100 |
| commit | e6fe960ac7e7e9087efc0e82a61c16c2cea107fe (patch) | |
| tree | ebdc299f4e3a5b8072b7c71c700a2f2a0cab5947 /ios/MullvadRustRuntime/include | |
| parent | 954d6f0abb42762991b20890ca9b572b9117f2fa (diff) | |
| download | mullvadvpn-e6fe960ac7e7e9087efc0e82a61c16c2cea107fe.tar.xz mullvadvpn-e6fe960ac7e7e9087efc0e82a61c16c2cea107fe.zip | |
Improve rust documentation
Diffstat (limited to 'ios/MullvadRustRuntime/include')
| -rw-r--r-- | ios/MullvadRustRuntime/include/mullvad_rust_runtime.h | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/ios/MullvadRustRuntime/include/mullvad_rust_runtime.h b/ios/MullvadRustRuntime/include/mullvad_rust_runtime.h index ad13d1f6e0..a45c6ed6c3 100644 --- a/ios/MullvadRustRuntime/include/mullvad_rust_runtime.h +++ b/ios/MullvadRustRuntime/include/mullvad_rust_runtime.h @@ -33,6 +33,15 @@ extern const uint16_t CONFIG_SERVICE_PORT; /** * Initializes a valid pointer to an instance of `EncryptedDnsProxyState`. + * + * # Safety + * + * * [domain_name] must not be non-null. + * + * * [domain_name] pointer must be [valid](core::ptr#safety) + * + * * The caller must ensure that the pointer to the [domain_name] string contains a nul terminator + * at the end of the string. */ struct EncryptedDnsProxyState *encrypted_dns_proxy_init(const char *domain_name); |