Struct gapi_grpc::google::devtools::clouddebugger::v2::Breakpoint

pub struct Breakpoint {
    pub id: String,
    pub action: i32,
    pub location: Option<SourceLocation>,
    pub condition: String,
    pub expressions: Vec<String>,
    pub log_message_format: String,
    pub log_level: i32,
    pub is_final_state: bool,
    pub create_time: Option<Timestamp>,
    pub final_time: Option<Timestamp>,
    pub user_email: String,
    pub status: Option<StatusMessage>,
    pub stack_frames: Vec<StackFrame>,
    pub evaluated_expressions: Vec<Variable>,
    pub variable_table: Vec<Variable>,
    pub labels: HashMap<String, String>,
}

Represents the breakpoint specification, status and results.

Fields

id: String

Breakpoint identifier, unique in the scope of the debuggee.

action: i32

Action that the agent should perform when the code at the breakpoint location is hit.

location: Option<SourceLocation>

Breakpoint source location.

condition: String

Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.

expressions: 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.

log_message_format: 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 ].

log_level: i32

Indicates the severity of the log. Only relevant when action is LOG.

is_final_state: bool

When true, indicates that this is a final result and the breakpoint state will not change from here on.

create_time: Option<Timestamp>

Time this breakpoint was created by the server in seconds resolution.

final_time: Option<Timestamp>

Time this breakpoint was finalized as seen by the server in seconds resolution.

user_email: String

E-mail address of the user that created this 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

stack_frames: Vec<StackFrame>

The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.

evaluated_expressions: 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.

variable_table: 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.

labels: HashMap<String, String>

A set of custom breakpoint properties, populated by the agent, to be displayed to the user.

Implementations

impl Breakpoint

pub fn action(&self) -> Action

Returns the enum value of action, or the default if the field is set to an invalid enum value.

pub fn set_action(&mut self, value: Action)

Sets action to the provided enum value.

pub fn log_level(&self) -> LogLevel

Returns the enum value of log_level, or the default if the field is set to an invalid enum value.

pub fn set_log_level(&mut self, value: LogLevel)

Sets log_level to the provided enum value.

Trait Implementations

impl Clone for Breakpoint

fn clone(&self) -> Breakpoint

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Breakpoint

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Breakpoint

fn default() -> Breakpoint

Returns the “default value” for a type.

impl Message for Breakpoint

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<Breakpoint> for Breakpoint

fn eq(&self, other: &Breakpoint) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Breakpoint) -> bool

This method tests for !=.

impl StructuralPartialEq for Breakpoint