Struct script::dom::bindings::weakref::WeakRef

pub struct WeakRef<T: WeakReferenceable> {
    ptr: NonNull<WeakBox<T>>,
}

A weak reference to a JS-managed DOM object.

Fields

ptr: NonNull<WeakBox<T>>

Implementations

impl<T: WeakReferenceable> WeakRef<T>

pub fn new(value: &T) -> Self

Create a new weak reference from a WeakReferenceable interface instance. This is just a convenience wrapper around <T as WeakReferenceable>::downgrade to not have to import WeakReferenceable.

pub fn root(&self) -> Option<Root<Dom<T>>>

DomRoot a weak reference. Returns None if the object was already collected.

pub fn is_alive(&self) -> bool

Return whether the weakly-referenced object is still alive.

Trait Implementations

impl<T: WeakReferenceable> Clone for WeakRef<T>

fn clone(&self) -> WeakRef<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: WeakReferenceable> Drop for WeakRef<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: WeakReferenceable> JSTraceable for WeakRef<T>

unsafe fn trace(&self, _: *mut JSTracer)

Trace self.

impl<T: WeakReferenceable> MallocSizeOf for WeakRef<T>

fn size_of(&self, _ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl<T: WeakReferenceable> PartialEq<T> for WeakRef<T>

fn eq(&self, other: &T) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: WeakReferenceable> PartialEq<WeakRef<T>> for WeakRef<T>

fn eq(&self, other: &Self) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.