Struct script::dom::bindings::import::module::jsapi::already_AddRefed

#[repr(C)]
pub struct already_AddRefed<T> {
    pub mRawPtr: *mut T,
    pub _phantom_0: PhantomData<UnsafeCell<T>>,
}

already_AddRefed cooperates with reference counting smart pointers to enable you to assign in a pointer without |AddRef|ing it. You might want to use this as a return type from a function that returns an already |AddRef|ed pointer. Or, you might want to use this as a parameter type in a function that wants to force a transfer-of-ownership from a RefPtr in the caller (for example, if the function expects callers to pass in a newly-created object, which the function then takes ownership of).

TODO Move already_AddRefed to namespace mozilla. This has not yet been done because of the sheer number of usages of already_AddRefed.

When should you use already_AddRefed<>?

• Ensure a consumer takes ownership of a reference
• Pass ownership without calling AddRef/Release (sometimes required in off-main-thread code)
• The ref pointer type you’re using doesn’t support move construction

Otherwise, use std::move(RefPtr/nsCOMPtr/etc).

Fields

mRawPtr: *mut T

_phantom_0: PhantomData<UnsafeCell<T>>

Trait Implementations

impl<T> Debug for already_AddRefed<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> PartialEq for already_AddRefed<T>

where T: PartialEq,

fn eq(&self, other: &already_AddRefed<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> StructuralPartialEq for already_AddRefed<T>