Sfoglia il codice sorgente

spin: add doc for `Spin`

greatbridf 10 mesi fa
parent
commit
25266c1a21
1 ha cambiato i file con 3 aggiunte e 0 eliminazioni
  1. 3 0
      crates/eonix_sync/src/spin.rs

+ 3 - 0
crates/eonix_sync/src/spin.rs

@@ -11,6 +11,9 @@ use core::{
 pub use guard::{SpinGuard, SpinIrqGuard};
 pub use relax::{LoopRelax, Relax, SpinRelax};
 
+//// A spinlock is a lock that uses busy-waiting to acquire the lock.
+/// It is useful for short critical sections where the overhead of a context switch
+/// is too high.
 #[derive(Debug, Default)]
 pub struct Spin<T, R = SpinRelax>
 where