Struct SyncWrapper

pub struct SyncWrapper<T>(/* private fields */);

A wrapper around a non-Sync type to make it Sync.

The mechanism is very simple. SyncWrapper prevents shared borrowing of the inner type. The only way to get to the inner data is through take or get_mut. Both methods can only be called with a mutable reference to SyncWrapper, so it’s not possible that the inner value can be observed simultaneously in multiple threads.

Implementations

impl<T> SyncWrapper<T>

pub fn new(value: T) -> Self

Construct a new SyncWrapper.

pub fn take(&mut self) -> Option<T>

Move out the inner value.

If this has already been called on this thread or elsewhere, this will return None.

pub fn get_mut(&mut self) -> Option<&mut T>

Obtain a mutable reference to the inner value.

If take has been called previously, this returns None.

Trait Implementations

impl<T: Debug> Debug for SyncWrapper<T>

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

Formats the value using the given formatter.

impl<T: Send> Sync for SyncWrapper<T>

Safety

SyncWrapper prevents shared borrowing of the inner type. The only way to get to the inner data is through take or get_mut. Both methods can only be called with a mutable reference to SyncWrapper, so it’s not possible that the inner value can be observed simultaneously in multiple threads.

Therefore, this implementation is safe.

For further reference, see the standard library’s implementation of Sync on core::sync::Mutex, as well as the get_mut method.