pub struct Gc<T: ?Sized + 'static> { /* private fields */ }
Expand description
A garbage-collected pointer type over an immutable value.
See the module level documentation for more details.
Implementations§
source§impl<T: Trace> Gc<T>
impl<T: Trace> Gc<T>
sourcepub fn new(value: T) -> Self
pub fn new(value: T) -> Self
Constructs a new Gc<T>
with the given value.
Collection
This method could trigger a garbage collection.
Examples
use gc::Gc;
let five = Gc::new(5);
assert_eq!(*five, 5);
source§impl<T: ?Sized> Gc<T>
impl<T: ?Sized> Gc<T>
sourcepub fn into_raw(this: Self) -> *const T
pub fn into_raw(this: Self) -> *const T
Consumes the Gc
, returning the wrapped pointer.
To avoid a memory leak, the pointer must be converted back into a Gc
using Gc::from_raw
.
Examples
use gc::Gc;
let x = Gc::new(22);
let x_ptr = Gc::into_raw(x);
assert_eq!(unsafe { *x_ptr }, 22);
unsafe { Gc::from_raw(x_ptr) };
sourcepub unsafe fn from_raw(ptr: *const T) -> Self
pub unsafe fn from_raw(ptr: *const T) -> Self
Constructs an Gc
from a raw pointer.
The raw pointer must have been previously returned by a call to a
Gc::into_raw
.
This function is unsafe because improper use may lead to memory problems. For example, a use-after-free will occur if the function is called twice on the same raw pointer.
Examples
use gc::Gc;
let x = Gc::new(22);
let x_ptr = Gc::into_raw(x);
unsafe {
// Convert back to an `Gc` to prevent leak.
let x = Gc::from_raw(x_ptr);
assert_eq!(*x, 22);
// Further calls to `Gc::from_raw(x_ptr)` would be memory unsafe.
}
// The memory can be freed at any time after `x` went out of scope above
// (when the collector is run), which would result in `x_ptr` dangling!
Trait Implementations§
source§impl<T: ?Sized + Ord> Ord for Gc<T>
impl<T: ?Sized + Ord> Ord for Gc<T>
source§impl<T: ?Sized + PartialEq> PartialEq<Gc<T>> for Gc<T>
impl<T: ?Sized + PartialEq> PartialEq<Gc<T>> for Gc<T>
source§impl<T: ?Sized + PartialOrd> PartialOrd<Gc<T>> for Gc<T>
impl<T: ?Sized + PartialOrd> PartialOrd<Gc<T>> for Gc<T>
source§impl<T: Trace + ?Sized> Trace for Gc<T>
impl<T: Trace + ?Sized> Trace for Gc<T>
source§fn finalize_glue(&self)
fn finalize_glue(&self)
Runs
Finalize::finalize()
on this object and all
contained subobjectsimpl<T: ?Sized + Eq> Eq for Gc<T>
Auto Trait Implementations§
impl<T> !RefUnwindSafe for Gc<T>
impl<T> !Send for Gc<T>
impl<T> !Sync for Gc<T>
impl<T: ?Sized> Unpin for Gc<T>
impl<T> !UnwindSafe for Gc<T>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more