diff options
| author | Sebastian Holmin <sebastian.holmin@mullvad.net> | 2025-01-09 14:55:57 +0100 |
|---|---|---|
| committer | Sebastian Holmin <sebastian.holmin@mullvad.net> | 2025-01-09 15:13:11 +0100 |
| commit | 722536451f683319f8d4e217afd761191a7e6aac (patch) | |
| tree | 6edf46efa241f11ec1f8b0cd1fbe58c41b088247 | |
| parent | 67f0b2c53830e18f2fd8f0b18291de369db7ab65 (diff) | |
| download | mullvadvpn-722536451f683319f8d4e217afd761191a7e6aac.tar.xz mullvadvpn-722536451f683319f8d4e217afd761191a7e6aac.zip | |
Add panic note to docstring
| -rw-r--r-- | talpid-tunnel-config-client/src/classic_mceliece.rs | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/talpid-tunnel-config-client/src/classic_mceliece.rs b/talpid-tunnel-config-client/src/classic_mceliece.rs index 93de357cdd..fbe69149cf 100644 --- a/talpid-tunnel-config-client/src/classic_mceliece.rs +++ b/talpid-tunnel-config-client/src/classic_mceliece.rs @@ -26,6 +26,10 @@ static KEYPAIR_RX: OnceLock<Mutex<mpsc::Receiver<KeyPair>>> = OnceLock::new(); /// /// It can take upwards of 200 ms to generate McEliece key pairs so it needs to be done before we /// start connecting to the tunnel. +/// +/// # Panic +/// +/// Panics if the buffer capacity is 0. pub fn spawn_keypair_worker(bufsize: usize) -> mpsc::Receiver<KeyPair> { let (tx, rx) = mpsc::channel(bufsize); |