Struct xpcom::interfaces::nsICycleCollectorHandler

#[repr(C)]
pub struct nsICycleCollectorHandler { /* fields omitted */ }

interface nsICycleCollectorHandler : nsISupports

/**
 * A set of interfaces for recording the cycle collector's work. An instance
 * of @mozilla.org/cycle-collector-logger;1 can be configured to enable various
 * options, then passed to the cycle collector when it runs.
 * Note that additional logging options are available by setting environment
 * variables, as described at the top of nsCycleCollector.cpp.
 */
/**
 * nsICycleCollectorHandler is the interface JS code should implement to
 * receive the results logged by a @mozilla.org/cycle-collector-logger;1
 * instance. Pass an instance of this to the logger's 'processNext' method
 * after the collection has run. This will describe the objects the cycle
 * collector visited, the edges it found, and the conclusions it reached
 * about the liveness of objects.
 *
 * In more detail:
 * - For each node in the graph:
 *   - a call is made to either |noteRefCountedObject| or |noteGCedObject|, to
 *     describe the node itself; and
 *   - for each edge starting at that node, a call is made to |noteEdge|.
 *
 * - Then, a series of calls are made to:
 *   - |describeRoot|, for reference-counted nodes that the CC has identified as
 *     being alive because there are unknown references to those nodes.
 *   - |describeGarbage|, for nodes the cycle collector has identified as garbage.
 *
 *   Any node not mentioned in a call to |describeRoot| or |describeGarbage| is
 *   neither a root nor garbage. The cycle collector was able to find all of the
 *   edges implied by the node's reference count.
 */

Methods

impl nsICycleCollectorHandler

pub fn coerce<T: nsICycleCollectorHandlerCoerce>(&self) -> &T

Cast this nsICycleCollectorHandler to one of its base interfaces.

impl nsICycleCollectorHandler

pub unsafe fn NoteRefCountedObject(
    &self,
    aAddress: &nsACString,
    aRefCount: uint32_t,
    aObjectDescription: &nsACString
) -> nsresult

void noteRefCountedObject (in ACString aAddress, in unsigned long aRefCount, in ACString aObjectDescription);

pub unsafe fn NoteGCedObject(
    &self,
    aAddress: &nsACString,
    aMarked: bool,
    aObjectDescription: &nsACString,
    aCompartmentAddress: &nsACString
) -> nsresult

void noteGCedObject (in ACString aAddress, in boolean aMarked, in ACString aObjectDescription, in ACString aCompartmentAddress);

pub unsafe fn NoteEdge(
    &self,
    aFromAddress: &nsACString,
    aToAddress: &nsACString,
    aEdgeName: &nsACString
) -> nsresult

void noteEdge (in ACString aFromAddress, in ACString aToAddress, in ACString aEdgeName);

pub unsafe fn DescribeRoot(
    &self,
    aAddress: &nsACString,
    aKnownEdges: uint32_t
) -> nsresult

void describeRoot (in ACString aAddress, in unsigned long aKnownEdges);

pub unsafe fn DescribeGarbage(&self, aAddress: &nsACString) -> nsresult

void describeGarbage (in ACString aAddress);

Methods from Deref<Target = nsISupports>

pub fn coerce<T: nsISupportsCoerce>(&self) -> &T

Cast this nsISupports to one of its base interfaces.

pub unsafe fn QueryInterface(
    &self,
    uuid: &nsIID,
    result: *mut *mut c_void
) -> nsresult

void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);

pub unsafe fn AddRef(&self) -> nsrefcnt

[noscript,notxpcom] nsrefcnt AddRef ();

pub unsafe fn Release(&self) -> nsrefcnt

[noscript,notxpcom] nsrefcnt Release ();

Trait Implementations

impl XpCom for nsICycleCollectorHandler

const IID: nsIID

IID: nsIID = nsID(2131309415, 5266, 19337, [135, 175, 192, 29, 188, 131, 18, 70])

fn query_interface<T: XpCom>(&self) -> Option<RefPtr<T>>

Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise.

impl RefCounted for nsICycleCollectorHandler

unsafe fn addref(&self)

Increment the reference count.

unsafe fn release(&self)

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsICycleCollectorHandler

type Target = nsISupports

The resulting type after dereferencing.

fn deref(&self) -> &nsISupports

Dereferences the value.