Struct ProtectedArc

pub(crate) struct ProtectedArc<P: ?Sized> {
    bomb: DropBomb,
    arc: Arc<P>,
}

An Arc, but containing a type which should only be dropped in certain places

In non #[cfg(test)] builds, this is just Arc<P>.

When testing, it has a drop bomb. You must call .promise_dropping_is_ok. It will panic if it’s simply dropped.

Fields

bomb: DropBomb

The actual explosive (might be armed or disarmed)

arc: Arc<P>

The underlying Arc

Implementations

impl<P: ?Sized> ProtectedArc<P>

pub(crate) fn new(arc: Arc<P>) -> Self

Make a new ProtectedArc from a raw Arc

CORRECTNESS

Presumably the Arc came from an uncontrolled external source, such as user code.

pub(crate) fn downgrade(&self) -> ProtectedWeak<P>

Obtain a ProtectedWeak from a &ProtectedArc

pub(crate) fn promise_dropping_is_ok(self) -> Arc<P>

Convert back into an unprotected Arc

CORRECTNESS

If the return value is dropped, the location must be suitable for that. Or, maybe the returned value is going to calling code in the external user, (which, therefore, wouldn’t pose a reentrancy hazard).

Trait Implementations

impl<P: Debug + ?Sized> Debug for ProtectedArc<P>

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

Formats the value using the given formatter.

impl<P: ?Sized> Deref for ProtectedArc<P>

where Arc<P>: Deref,

type Target = <Arc<P> as Deref>::Target

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<P: ?Sized> DerefMut for ProtectedArc<P>

where Arc<P>: DerefMut,

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.