Struct TlsScopeGuard

Source

struct TlsScopeGuard {
    scope_ptr: NonNull<ProtectScope>,
}

Expand description

Execute a closure with a new protection scope as the current TLS scope.

The scope is pushed onto the thread-local stack, the closure runs, and then the scope is popped and dropped (triggering UNPROTECT(n)).

§Safety

Must be called from the R main thread.

§Example

unsafe fn my_call(x: SEXP) -> SEXP {
    tls::with_protect_scope(|| {
        let x = tls::protect(x);
        let y = tls::protect(allocate_something());
        combine(x.get(), y.get())
    })
}

Guard that pops the TLS scope stack on drop (panic-safe cleanup).

Fields§

§scope_ptr: NonNull<ProtectScope>

Trait Implementations§

Source §

impl Drop for TlsScopeGuard

Source §

fn drop(&mut self)

Executes the destructor for this type. Read more

Source §

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for TlsScopeGuard

§

impl !UnwindSafe for TlsScopeGuard

§

impl UnsafeUnpin for TlsScopeGuard

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, U> Into 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> SizeHint for T
where T: ?Sized,

Source §

default fn lower_bound(&self) -> usize

🔬This is a nightly-only experimental API. (core_io_internals)

Returns a lower bound on the number of elements this container-like item contains. For example, an array [u8; 12] could return any value between 0 and 12 inclusively as a correct implementation. Read more

Source §

default fn upper_bound(&self) -> Option<usize>

🔬This is a nightly-only experimental API. (core_io_internals)

Returns an upper bound on the number of elements this container-like item contains if it can be determined, otherwise None. Read more

Source §

final fn size_hint(&self) -> (usize, Option<usize>)

🔬This is a nightly-only experimental API. (core_io_internals)

Returns an estimate for the number of elements this container like type contains. Read more

Source §