Struct critical_section::CriticalSection
source · pub struct CriticalSection<'cs> { /* private fields */ }
Expand description
Critical section token.
An instance of this type indicates that the current thread is executing code within a critical section.
Implementations§
source§impl<'cs> CriticalSection<'cs>
impl<'cs> CriticalSection<'cs>
sourcepub unsafe fn new() -> Self
pub unsafe fn new() -> Self
Creates a critical section token.
This method is meant to be used to create safe abstractions rather than being directly used in applications.
§Safety
This must only be called when the current thread is in a critical section. The caller must ensure that the returned instance will not live beyond the end of the critical section.
The caller must use adequate fences to prevent the compiler from moving the instructions inside the critical section to the outside of it. Sequentially consistent fences are suggested immediately after entry and immediately before exit from the critical section.
Note that the lifetime 'cs
of the returned instance is unconstrained. User code must not
be able to influence the lifetime picked for this type, since that might cause it to be
inferred to 'static
.
Trait Implementations§
source§impl<'cs> Clone for CriticalSection<'cs>
impl<'cs> Clone for CriticalSection<'cs>
source§fn clone(&self) -> CriticalSection<'cs>
fn clone(&self) -> CriticalSection<'cs>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more