reven2.stack.FrameStart

class documentation

class FrameStart:

Representation of the event starting a frame of a stack.

Warnings

Must not be directly constructed but retrieved through the StackFrame.start_event property.

Method	`__eq__`	Compares the instance for equality with an object.
Method	`__hash__`	Undocumented
Method	`__init__`	Undocumented
Method	`__repr__`	Returns the "official" string representation of this instance.
Method	`__str__`	Returns the nicely printable string representation of this instance.
Property	`frame`	Property: The frame associated with the event.
Property	`stack`	Property: The stack associated with the event.
Property	`trampoline`	Property: If the function is using a trampoline at its start, the transition where the trampoline ended.
Property	`transition`	Property: The transition where this event happened.
Property	`type`	Property: The type of the start.
Instance Variable	`_data_source`	Undocumented
Instance Variable	`_frame`	Undocumented
Instance Variable	`_id`	Undocumented
Instance Variable	`_stack`	Undocumented
Instance Variable	`_trace`	Undocumented
Instance Variable	`_trampoline`	Undocumented
Instance Variable	`_transition`	Undocumented
Instance Variable	`_type`	Undocumented

def __eq__(self, other):

Compares the instance for equality with an object.

if the object is not a FrameStart, will return False.

Parameters
other:`object`	Undocumented
Returns
`bool`	Undocumented

def __hash__(self):

Undocumented

Returns
`int`	Undocumented

def __init__(self, data_source, trace, frame, rvn_frame_start):

Undocumented

Parameters
data_source:`_DataSource`	Undocumented
trace:`_Trace`	Undocumented
frame:`StackFrame`	Undocumented
rvn_frame_start:`_reven_api.StackFrameStartEvent`	Undocumented

def __repr__(self):

Returns the "official" string representation of this instance.

Returns
`str`	Undocumented

def __str__(self):

Returns the nicely printable string representation of this instance.

Returns
`str`	Undocumented

@property
frame: StackFrame =

Property: The frame associated with the event.

@property
stack: StackSpace =

Property: The stack associated with the event.

@property
trampoline: _Optional[_Transition] =

Property: If the function is using a trampoline at its start, the transition where the trampoline ended.

@property
transition: _Optional[_Transition] =

Property: The transition where this event happened.

@property
type: FrameStartType =

Property: The type of the start.

It indicates in which context the frame was created.

_data_source =

Undocumented

_frame =

Undocumented

_id =

Undocumented

_stack =

Undocumented

_trace =

Undocumented

_trampoline =

Undocumented

_transition =

Undocumented

_type =

Undocumented