Struct gc::Gc [−][src]
A garbage-collected pointer type over an immutable value.
See the module level documentation for more details.
Implementations
impl<T: Trace> Gc<T>
[src]
impl<T: Trace> Gc<T>
[src]pub fn new(value: T) -> Self
[src]
pub fn new(value: T) -> Self
[src]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);
impl<T: Trace + ?Sized> Gc<T>
[src]
impl<T: Trace + ?Sized> Gc<T>
[src]pub fn into_raw(this: Self) -> *const T
[src]
pub fn into_raw(this: Self) -> *const T
[src]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);
pub unsafe fn from_raw(ptr: *const T) -> Self
[src]
pub unsafe fn from_raw(ptr: *const T) -> Self
[src]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
impl<T: Trace + ?Sized + Ord> Ord for Gc<T>
[src]
impl<T: Trace + ?Sized + Ord> Ord for Gc<T>
[src]impl<T: Trace + ?Sized + PartialOrd> PartialOrd<Gc<T>> for Gc<T>
[src]
impl<T: Trace + ?Sized + PartialOrd> PartialOrd<Gc<T>> for Gc<T>
[src]fn partial_cmp(&self, other: &Self) -> Option<Ordering>
[src]
fn partial_cmp(&self, other: &Self) -> Option<Ordering>
[src]This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Self) -> bool
[src]
fn lt(&self, other: &Self) -> bool
[src]This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &Self) -> bool
[src]
fn le(&self, other: &Self) -> bool
[src]This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl<T: Trace + ?Sized> Trace for Gc<T>
[src]
impl<T: Trace + ?Sized> Trace for Gc<T>
[src]fn finalize_glue(&self)
[src]
fn finalize_glue(&self)
[src]Runs Finalize::finalize() on this object and all contained subobjects Read more
impl<T: Trace + ?Sized + Eq> Eq for Gc<T>
[src]
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
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more