Class: Canopus::Breakpoints

Inherits:

Object

• Object
• Canopus::Breakpoints

Defined in:

sig/debug.rbs

Defined Under Namespace

Classes: Entry

Constant Summary

VERSION =

Returns:

• (Integer)

RELATIVE_PATH =

Returns:

• (String)

MAX_BYTES =

Returns:

• (Integer)

MAX_ENTRIES =

Returns:

• (Integer)

MAX_PATH_BYTES =

Returns:

• (Integer)

MAX_CONDITION_BYTES =

Returns:

• (Integer)

MAX_HIT_CONDITION_BYTES =

Returns:

• (Integer)

MAX_LOG_MESSAGE_BYTES =

Returns:

• (Integer)

MAX_LINE =

Returns:

• (Integer)

Instance Attribute Summary

• #entries ⇒ Array[Entry] readonly

  Returns the value of attribute entries.

• #root ⇒ String readonly

  Returns the value of attribute root.

Instance Method Summary

• #add ⇒ Entry
• #attach ⇒ self
• #close ⇒ nil
• #detach ⇒ Boolean
• #error ⇒ StandardError^?
• #flush ⇒ self
• #for_path ⇒ Array[Entry]
• #initialize ⇒ Breakpoints constructor

  A new instance of Breakpoints.

• #remove ⇒ Boolean
• #toggle ⇒ Entry^?
• #update ⇒ Entry

Constructor Details

#initialize ⇒ Breakpoints

Returns a new instance of Breakpoints.

Parameters:

• root: (String)

# File 'sig/debug.rbs', line 47

def initialize: (root: String) ?{ (String) -> void } -> void

Instance Attribute Details

#entries ⇒ Array[Entry] (readonly)

Returns the value of attribute entries.

Returns:

• (Array[Entry])

# File 'sig/debug.rbs', line 45

def entries
  @entries
end

#root ⇒ String (readonly)

Returns the value of attribute root.

Returns:

• (String)

# File 'sig/debug.rbs', line 44

def root
  @root
end

Instance Method Details

#add ⇒ Entry

Parameters:

• path (String)
• line (Integer)
• condition: (String, nil)
• hit_condition: (String, nil)
• log_message: (String, nil)
• enabled: (Boolean)

Returns:

• (Entry)

# File 'sig/debug.rbs', line 49

def add: (String path, Integer line, ?condition: String?, ?hit_condition: String?, ?log_message: String?, ?enabled: bool) -> Entry

#attach ⇒ self

Parameters:

• buffer (Canopus::Buffer)

Returns:

• (self)

# File 'sig/debug.rbs', line 53

def attach: (Canopus::Buffer buffer) -> self

#close ⇒ nil

Returns:

• (nil)

# File 'sig/debug.rbs', line 55

def close: () -> nil

#detach ⇒ Boolean

Parameters:

• buffer (Canopus::Buffer)

Returns:

• (Boolean)

# File 'sig/debug.rbs', line 54

def detach: (Canopus::Buffer buffer) -> bool

#error ⇒ StandardError^?

Returns:

• (StandardError, nil)

# File 'sig/debug.rbs', line 57

def error: () -> StandardError?

#flush ⇒ self

Returns:

• (self)

# File 'sig/debug.rbs', line 56

def flush: () -> self

#for_path ⇒ Array[Entry]

Parameters:

• path (String)

Returns:

• (Array[Entry])

# File 'sig/debug.rbs', line 48

def for_path: (String path) -> Array[Entry]

#remove ⇒ Boolean

Parameters:

• path (String)
• line (Integer)

Returns:

• (Boolean)

# File 'sig/debug.rbs', line 50

def remove: (String path, Integer line) -> bool

#toggle ⇒ Entry^?

Parameters:

• path (String)
• line (Integer)
• condition: (String, nil)
• hit_condition: (String, nil)
• log_message: (String, nil)
• enabled: (Boolean)

Returns:

• (Entry, nil)

# File 'sig/debug.rbs', line 51

def toggle: (String path, Integer line, ?condition: String?, ?hit_condition: String?, ?log_message: String?, ?enabled: bool) -> Entry?

#update ⇒ Entry

Parameters:

• path (String)
• line (Integer)
• new_line: (Integer)
• condition: (String, nil)
• hit_condition: (String, nil)
• log_message: (String, nil)
• enabled: (Boolean)

Returns:

• (Entry)

# File 'sig/debug.rbs', line 52

def update: (String path, Integer line, ?new_line: Integer, ?condition: String?, ?hit_condition: String?, ?log_message: String?, ?enabled: bool) -> Entry