Interface nsIDebug2Type

Note

C/C++ consumers who are planning to use the nsIDebug2 interface with the "@mozilla.org/xpcom;1" contract should use NS_DebugBreak from xpcom glue instead.

Hierarchy

Properties

assertionCount isDebugBuild isDebuggerAttached

Methods

AddRef QueryInterface Release abort assertion break crashWithOOM rustLog rustPanic warning

Properties

Readonly assertionCount

assertionCount: number

The number of assertions since process start.

Readonly isDebugBuild

isDebugBuild: boolean

Whether XPCOM was compiled with DEBUG defined. This often correlates to whether other code (e.g., Firefox, XULRunner) was compiled with DEBUG defined.

Readonly isDebuggerAttached

isDebuggerAttached: bool

Whether a debugger is currently attached. Supports Windows + Mac

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

abort

  • Request the process to trigger a fatal abort.

    Parameters

    • aFile: string

      file containing abort request

    • aLine: number

      line number of abort request

    Returns void

assertion

  • Show an assertion and trigger nsIDebug2.break().

    Parameters

    • aStr: string

      assertion message

    • aExpr: string

      expression that failed

    • aFile: string

      file containing assertion

    • aLine: number

      line number of assertion

    Returns void

break

  • Request to break into a debugger.

    Parameters

    • aFile: string

      file containing break request

    • aLine: number

      line number of break request

    Returns void

crashWithOOM

  • Cause an Out of Memory Crash.

    Returns void

rustLog

  • Request the process to log a message for a target and level from Rust code.

    Parameters

    • aTarget: string

      the string representing the log target.

    • aMessage: string

      the string representing the log message.

    Returns void

rustPanic

  • Request the process to trigger a fatal panic!() from Rust code.

    Parameters

    • aMessage: string

      the string to pass to panic!().

    Returns void

warning

  • Show a warning.

    Parameters

    • aStr: string

      warning message

    • aFile: string

      file containing assertion

    • aLine: number

      line number of assertion

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc