Skip to main content

Root

miniextendr_api::gc_protect

Struct Root 

Source 
pub struct Root<'a> {
    sexp: SEXP,
    _scope: PhantomData<&'a ProtectScope>,
}
Expand description

A rooted SEXP tied to the lifetime of a ProtectScope.

This type has no Drop. The scope owns unprotection responsibility. This makes Root cheap to move and copy (it’s just a pointer + lifetime).

§Lifetime

The 'a lifetime ties the root to its creating scope. The compiler ensures you cannot use the root after the scope has been dropped.

Fields§

§sexp: SEXP§_scope: PhantomData<&'a ProtectScope>

Implementations§

Source§

impl<'a> Root<'a>

Source

pub fn get(&self) -> SEXP

Get the underlying SEXP.

Source

pub fn into_raw(self) -> SEXP

Consume the root and return the underlying SEXP.

The SEXP remains protected until the scope drops.

Trait Implementations§

Source§

impl<'a> Clone for Root<'a>

Source§

fn clone(&self) -> Root<'a>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'a> Deref for Root<'a>

Source§

type Target = SEXP

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

impl<'a> Copy for Root<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for Root<'a>

§

impl<'a> !RefUnwindSafe for Root<'a>

§

impl<'a> !Send for Root<'a>

§

impl<'a> !Sync for Root<'a>

§

impl<'a> Unpin for Root<'a>

§

impl<'a> UnsafeUnpin for Root<'a>

§

impl<'a> !UnwindSafe for Root<'a>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> RClone for T
where T: Clone,

Source§

fn clone(&self) -> T

Create a deep copy of this value.
Source§

impl<T> RCopy for T
where T: Copy,

Source§

fn copy(&self) -> T

Create a bitwise copy of this value. Read more
Source§

fn is_copy(&self) -> bool

Check if this type implements Copy. Read more
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.