Unshared

Struct Unshared 

Source
pub struct Unshared<T>(/* private fields */);
Expand description

NOTE: This type was adapted from https://github.com/Nullus157/async-compression/blob/main/src/unshared.rs Original implementation licensed MIT/Apache 2

Wraps a type and only allows unique borrowing, the main usecase is to wrap a !Sync type and implement Sync for it as this type blocks having multiple shared references to the inner value.

§Safety

We must be careful when accessing inner, there must be no way to create a shared reference to it from a shared reference to an Unshared, as that would allow creating shared references on multiple threads.

As an example deriving or implementing Clone is impossible, two threads could attempt to clone a shared Unshared<T> reference which would result in accessing the same inner value concurrently.

Implementations§

Source§

impl<T> Unshared<T>

Source

pub fn new(inner: T) -> Self

Initialize a new Unshared, wrapping the provided inner value

Source

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

Get a mutable (unique) reference to the inner value

Trait Implementations§

Source§

impl<T> Debug for Unshared<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Sync for Unshared<T>

Safety: See comments on main docs for Unshared

Auto Trait Implementations§

§

impl<T> Freeze for Unshared<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Unshared<T>
where T: RefUnwindSafe,

§

impl<T> Send for Unshared<T>
where T: Send,

§

impl<T> Unpin for Unshared<T>
where T: Unpin,

§

impl<T> UnwindSafe for Unshared<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<S> ConditionalSend for S
where S: Send,

Source§

impl<S> ConditionalSync for S
where S: Send + Sync,