Struct google_clouddebugger2::api::Breakpoint
source · pub struct Breakpoint {Show 18 fields
pub action: Option<String>,
pub canary_expire_time: Option<DateTime<Utc>>,
pub condition: Option<String>,
pub create_time: Option<DateTime<Utc>>,
pub evaluated_expressions: Option<Vec<Variable>>,
pub expressions: Option<Vec<String>>,
pub final_time: Option<DateTime<Utc>>,
pub id: Option<String>,
pub is_final_state: Option<bool>,
pub labels: Option<HashMap<String, String>>,
pub location: Option<SourceLocation>,
pub log_level: Option<String>,
pub log_message_format: Option<String>,
pub stack_frames: Option<Vec<StackFrame>>,
pub state: Option<String>,
pub status: Option<StatusMessage>,
pub user_email: Option<String>,
pub variable_table: Option<Vec<Variable>>,
}
Expand description
—————————————————————————— ## Breakpoint (the resource) Represents the breakpoint specification, status and results.
§Activities
This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).
- debuggees breakpoints set debugger (request)
Fields§
§action: Option<String>
Action that the agent should perform when the code at the breakpoint location is hit.
canary_expire_time: Option<DateTime<Utc>>
The deadline for the breakpoint to stay in CANARY_ACTIVE state. The value is meaningless when the breakpoint is not in CANARY_ACTIVE state.
condition: Option<String>
Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.
create_time: Option<DateTime<Utc>>
Time this breakpoint was created by the server in seconds resolution.
evaluated_expressions: Option<Vec<Variable>>
Values of evaluated expressions at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the expressions
field. The name
field holds the original expression text, the value
or members
field holds the result of the evaluated expression. If the expression cannot be evaluated, the status
inside the Variable
will indicate an error and contain the error text.
expressions: Option<Vec<String>>
List of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is LOG
, the evaluated expressions are included in log statements.
final_time: Option<DateTime<Utc>>
Time this breakpoint was finalized as seen by the server in seconds resolution.
id: Option<String>
Breakpoint identifier, unique in the scope of the debuggee.
is_final_state: Option<bool>
When true, indicates that this is a final result and the breakpoint state will not change from here on.
labels: Option<HashMap<String, String>>
A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
location: Option<SourceLocation>
Breakpoint source location.
log_level: Option<String>
Indicates the severity of the log. Only relevant when action is LOG
.
log_message_format: Option<String>
Only relevant when action is LOG
. Defines the message to log when the breakpoint hits. The message may include parameter placeholders $0
, $1
, etc. These placeholders are replaced with the evaluated value of the appropriate expression. Expressions not referenced in log_message_format
are not logged. Example: Message received, id = $0, count = $1
with expressions
= [ message.id, message.count ]
.
stack_frames: Option<Vec<StackFrame>>
The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.
state: Option<String>
The current state of the breakpoint.
status: Option<StatusMessage>
Breakpoint status. The status includes an error flag and a human readable message. This field is usually unset. The message can be either informational or an error message. Regardless, clients should always display the text message back to the user. Error status indicates complete failure of the breakpoint. Example (non-final state): Still loading symbols...
Examples (final state): * Invalid line number
referring to location * Field f not found in class C
referring to condition
user_email: Option<String>
E-mail address of the user that created this breakpoint
variable_table: Option<Vec<Variable>>
The variable_table
exists to aid with computation, memory and network traffic optimization. It enables storing a variable once and reference it from multiple variables, including variables stored in the variable_table
itself. For example, the same this
object, which may appear at many levels of the stack, can have all of its data stored once in this table. The stack frame variables then would hold only a reference to it. The variable var_table_index
field is an index into this repeated field. The stored objects are nameless and get their name from the referencing variable. The effective variable is a merge of the referencing variable and the referenced variable.
Trait Implementations§
source§impl Clone for Breakpoint
impl Clone for Breakpoint
source§fn clone(&self) -> Breakpoint
fn clone(&self) -> Breakpoint
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more