Struct pgc::Rooted

pub struct Rooted<T: GcObject + 'static> { /* fields omitted */ }

An structure to hold root object alive until end of it's live. Internally this structure uses reference counting.

use ngc::*;

{
    let object = Rooted::new(42); // is_root(object) = true

} // drop `Rooted` and unroot allocated object
gc_collect();

Methods

impl<T: GcObject + 'static> Rooted<T>

pub fn new(val: T) -> Self

Construct new rooted object.

pub fn with(x: Gc<T>) -> Self

pub fn inner(&self) -> Gc<T>

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

pub fn get(&self) -> &T

Trait Implementations

impl<T: 'static + GcObject> Drop for Rooted<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: 'static + GcObject> Clone for Rooted<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: GcObject + 'static> From<Rooted<T>> for Gc<T>

fn from(x: Rooted<T>) -> Self

Performs the conversion.