Struct mozjs::jsapi::already_AddRefed
source · #[repr(C)]pub struct already_AddRefed<T> {
pub mRawPtr: *mut T,
pub _phantom_0: PhantomData<UnsafeCell<T>>,
}
Expand description
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.
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§
source§impl<T> Debug for already_AddRefed<T>where
T: Debug,
impl<T> Debug for already_AddRefed<T>where T: Debug,
source§impl<T> PartialEq<already_AddRefed<T>> for already_AddRefed<T>where
T: PartialEq<T>,
impl<T> PartialEq<already_AddRefed<T>> for already_AddRefed<T>where T: PartialEq<T>,
source§fn eq(&self, other: &already_AddRefed<T>) -> bool
fn eq(&self, other: &already_AddRefed<T>) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.impl<T> StructuralPartialEq for already_AddRefed<T>
Auto Trait Implementations§
impl<T> !RefUnwindSafe for already_AddRefed<T>
impl<T> !Send for already_AddRefed<T>
impl<T> !Sync for already_AddRefed<T>
impl<T> Unpin for already_AddRefed<T>where T: Unpin,
impl<T> UnwindSafe for already_AddRefed<T>where T: UnwindSafe + RefUnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more