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]
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]
pub fn ptr_eq(this: &Gc<T>, other: &Gc<T>) -> bool
[src]
Returns true
if the two Gc
s point to the same allocation.
impl<T: Trace + ?Sized> Gc<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]
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> AsRef<T> for Gc<T>
[src]
impl<T: Trace + ?Sized> Borrow<T> for Gc<T>
[src]
impl<T: Trace + ?Sized> Clone for Gc<T>
[src]
fn clone(&self) -> Self
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<T: Trace + ?Sized + Debug> Debug for Gc<T>
[src]
impl<T: Trace + Default> Default for Gc<T>
[src]
impl<T: Trace + ?Sized> Deref for Gc<T>
[src]
impl<T: Trace + ?Sized + Display> Display for Gc<T>
[src]
impl<T: Trace + ?Sized> Drop for Gc<T>
[src]
impl<T: Trace + ?Sized + Eq> Eq for Gc<T>
[src]
impl<T: Trace + ?Sized> Finalize for Gc<T>
[src]
impl<T: Trace> From<T> for Gc<T>
[src]
impl<T: Trace + ?Sized + Hash> Hash for Gc<T>
[src]
fn hash<H: Hasher>(&self, state: &mut H)
[src]
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl<T: Trace + ?Sized + Ord> Ord for Gc<T>
[src]
fn cmp(&self, other: &Self) -> Ordering
[src]
#[must_use]pub fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]
impl<T: Trace + ?Sized + PartialEq> PartialEq<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 lt(&self, other: &Self) -> bool
[src]
fn le(&self, other: &Self) -> bool
[src]
fn gt(&self, other: &Self) -> bool
[src]
fn ge(&self, other: &Self) -> bool
[src]
impl<T: Trace + ?Sized> Pointer for Gc<T>
[src]
impl<T: Trace + ?Sized> Trace for Gc<T>
[src]
Auto Trait Implementations
impl<T> !RefUnwindSafe for Gc<T>
[src]
impl<T> !Send for Gc<T>
[src]
impl<T> !Sync for Gc<T>
[src]
impl<T: ?Sized> Unpin for Gc<T>
[src]
impl<T> !UnwindSafe for Gc<T>
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<!> for T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,