Skip to content

Commit

Permalink
Add panic note to docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
Serock3 committed Jan 9, 2025
1 parent 439a31f commit 3e065b8
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions talpid-tunnel-config-client/src/classic_mceliece.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down

0 comments on commit 3e065b8

Please sign in to comment.