Struct spin_sync::Once

pub struct Once { /* fields omitted */ }

A synchronization primitive which can be used to run a one-time global initialization.

Once behaves like std::sync::Once except for using spinlock. Useful for one-time initialization for FFI or related functionality.

Examples

use spin_sync::Once;

static INIT: Once = Once::new();

INIT.call_once(|| {
    // Do some initialization here.
});

Implementations

impl Once

pub const fn new() -> Self

Create a new Once instance.

pub fn call_once<F: FnOnce()>(&self, f: F)

Performs an initialization routine once and only once. The given closure will be executed if this is the first time call_once has been called, and otherwise the routine will not be invoked.

This method will block the calling thread if another initialization routine is currently running.

When this function returns, it is guaranteed that some initialization has run and completed (it may not be the closure specified). It is also guaranteed that any memory writes performed by the executed closure can be reliably observed by other threads at this point (there is a happens-before relation between the closure and code executing after the return).

If the given closure recursively invokes call_once on the same Once instance the exact behavior is not specified, allowed outcomes are a panic or a deadlock.

Examples

Once enable to access static mut data safely.

use spin_sync::Once;

static mut CACHE: usize = 0;
static INIT: Once = Once::new();

fn expensive_calculation(val: usize) -> usize {
    unsafe {
        INIT.call_once(|| { CACHE = val; });
        CACHE
    }
}

// INIT.call_once() invokes the closure and set the CACHE.
assert_eq!(1, expensive_calculation(1));

// INIT.call_once() do nothing and return the CACHE.
assert_eq!(1, expensive_calculation(2));

Panics

The closure f will only be executed once if this is called concurrently among many threads. If that closure panics, however, then it will poison this Once instance, causing all future invocations of call_once to also panic.

pub fn call_once_force<F: FnOnce(&OnceState)>(&self, f: F)

Performs the same function as call_once except ignores poisoning.

Unlike call_once, if this Once has been poisoned (i.e., a previous call to call_once or call_once_force caused a panic), calling call_once_force will still invoke the closure f and will not result in an immediate panic. If f panics, the Once will remain in a poison state. If f does not panic, the Once will no longer be in a poison state and all future calls to call_once or call_once_force will be no-ops.

The closure f is yielded a OnceState structure which can be used to query the poison status of the Once.

Examples

use spin_sync::Once;
use std::thread;

static INIT: Once = Once::new();

// Poison INIT
let handle = thread::spawn(|| {
    INIT.call_once(|| panic!());
});
assert!(handle.join().is_err());

// Poisoning propagates
let handle = thread::spawn(|| {
    INIT.call_once(|| {});
});
assert!(handle.join().is_err());

// call_once_force will still run and reset the poisoned state
INIT.call_once_force(|state| {
    assert!(state.poisoned());
});

// once any success happens, we stop propagating the poison
INIT.call_once(|| {});

#[must_use]pub fn is_completed(&self) -> bool

Returns true if some call_once call has completed successfully. Specifically, is_completed will return false in the following situations:

• Neither call_once nor call_once_force was not called at all,
• call_once or/and call_once_force was called, but has not yet completed,
• the Once instance is poisoned

This function returning false does not mean that Once has not been executed. For example, it may have been executed in the time between when is_completed starts executing and when it returns, in which case the false return value would be stale (but still permissible).

Examples

call_once was succeeded.

use spin_sync::Once;

static INIT: Once = Once::new();

assert_eq!(INIT.is_completed(), false);
INIT.call_once(|| {
    assert_eq!(INIT.is_completed(), false);
});
assert_eq!(INIT.is_completed(), true);

call_once caused panic.

use spin_sync::Once;
use std::thread;

static INIT: Once = Once::new();

assert_eq!(INIT.is_completed(), false);
let handle = thread::spawn(|| {
    INIT.call_once(|| panic!());
});
assert!(handle.join().is_err());
assert_eq!(INIT.is_completed(), false);

Trait Implementations

impl Debug for Once

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.