Struct gluon_vm::gc::Borrow

pub struct Borrow<'a, T>(_, _);

Implementations

impl<'gc, T> Borrow<'gc, T>

pub fn new(value: &'gc T) -> Borrow<'gc, T::Value> where
    T: CloneUnrooted, 

pub fn from_static(value: T) -> Self where
    T: 'static, 

pub fn map<U>(&self, f: impl FnOnce(&T) -> &U) -> Borrow<'gc, U::Value> where
    U: CloneUnrooted, 

pub unsafe fn map_unrooted<U>(self, f: impl FnOnce(T) -> U) -> Borrow<'gc, U>

pub unsafe fn unrooted(self) -> T

pub fn as_lifetime(&self) -> &'gc ()

impl<'a, T: ?Sized> Borrow<'a, GcPtr<T>>

pub fn as_ref(&self) -> &'a T

Trait Implementations

impl<T, '_> CloneUnrooted for Borrow<'_, T> where
    T: CloneUnrooted, 

type Value = T::Value

unsafe fn clone_unrooted(&self) -> Self::Value

Creates a clone of the value that is not rooted. To ensure safety the value must be forgotten or rooted before the next garbage collection

impl<'a, T> DataDef for Borrow<'a, T> where
    T: DataDef,
    T::Value: Sized, 

type Value = T::Value

The type of the value allocated.

fn size(&self) -> usize

Returns how many bytes need to be allocted for this DataDef

fn initialize(self, result: WriteOnly<'_, Self::Value>) -> &mut Self::Value

Consumes self to initialize the allocated value. Returns the initialized pointer.

fn fields(&self) -> Option<&[InternedStr]>

fn tag(&self) -> Option<&InternedStr>

impl<'a, T: Debug> Debug for Borrow<'a, T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T, '_> Deref for Borrow<'_, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T, '_> DerefMut for Borrow<'_, T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<'a, T: Eq> Eq for Borrow<'a, T>

impl<'gc> From<Borrow<'gc, GcPtr<Box<dyn Userdata + 'static>>>> for Variants<'gc>

fn from(v: GcRef<'gc, Box<dyn Userdata>>) -> Self

Performs the conversion.

impl<'gc> From<Borrow<'gc, GcPtr<ClosureData>>> for Variants<'gc>

fn from(v: GcRef<'gc, ClosureData>) -> Self

Performs the conversion.

impl<'gc> From<Borrow<'gc, GcPtr<DataStruct>>> for Variants<'gc>

fn from(v: GcRef<'gc, DataStruct>) -> Self

Performs the conversion.

impl<'gc> From<Borrow<'gc, GcPtr<ExternFunction>>> for Variants<'gc>

fn from(v: GcRef<'gc, ExternFunction>) -> Self

Performs the conversion.

impl<'gc> From<Borrow<'gc, GcPtr<PartialApplicationData>>> for Variants<'gc>

fn from(v: GcRef<'gc, PartialApplicationData>) -> Self

Performs the conversion.

impl<'gc> From<Borrow<'gc, GcPtr<Thread>>> for Variants<'gc>

fn from(v: GcRef<'gc, Thread>) -> Self

Performs the conversion.

impl<'gc> From<Borrow<'gc, GcPtr<ValueArray>>> for Variants<'gc>

fn from(v: GcRef<'gc, ValueArray>) -> Self

Performs the conversion.

impl<'gc> From<Borrow<'gc, GcPtr<ValueStr>>> for Variants<'gc>

fn from(v: GcRef<'gc, ValueStr>) -> Self

Performs the conversion.

impl<'gc, T: ?Sized> From<Borrow<'gc, OwnedPtr<T>>> for GcRef<'gc, T>

fn from(ptr: OwnedGcRef<'gc, T>) -> Self

Freezes self into a shared pointer

impl<'a, T: PartialEq> PartialEq<Borrow<'a, T>> for Borrow<'a, T>

fn eq(&self, other: &Borrow<'a, T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Borrow<'a, T>) -> bool

This method tests for !=.

impl<'a, T: StackPrimitive + 'a> StackPrimitive for Borrow<'a, T>

fn push_to(&self, stack: &mut Stack)

fn extend_to<'b, I>(iter: I, stack: &mut Stack) where
    I: IntoIterator<Item = &'b Self>,
    Self: 'b, 

impl<'a, T> StructuralEq for Borrow<'a, T>

impl<'a, T> StructuralPartialEq for Borrow<'a, T>

impl<'a, T: Trace> Trace for Borrow<'a, T>

fn trace(&self, gc: &mut Gc)

unsafe fn root(&mut self)

unsafe fn unroot(&mut self)