Class: Prism::RescueModifierNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents an expression modified with a rescue.

foo rescue nil
^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(expression, keyword_loc, rescue_expression, location) ⇒ RescueModifierNode

def initialize: (expression: Node, keyword_loc: Location, rescue_expression: Node, location: Location) -> void



14660
14661
14662
14663
14664
14665
 
# File 'lib/prism/node.rb', line 14660

def initialize(expression, keyword_loc, rescue_expression, location)
  @expression = expression
  @keyword_loc = keyword_loc
  @rescue_expression = rescue_expression
  @location = location
end

Instance Attribute Details

#expression ⇒ Object (readonly)

attr_reader expression: Node



14651
14652
14653
 
# File 'lib/prism/node.rb', line 14651

def expression
  @expression
end

#keyword_loc ⇒ Object (readonly)

attr_reader keyword_loc: Location



14654
14655
14656
 
# File 'lib/prism/node.rb', line 14654

def keyword_loc
  @keyword_loc
end

#rescue_expression ⇒ Object (readonly)

attr_reader rescue_expression: Node



14657
14658
14659
 
# File 'lib/prism/node.rb', line 14657

def rescue_expression
  @rescue_expression
end

Class Method Details

.type ⇒ Object

Similar to #type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like #type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.

def self.type: () -> Symbol



14749
14750
14751
 
# File 'lib/prism/node.rb', line 14749

def self.type
  :rescue_modifier_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



14668
14669
14670
 
# File 'lib/prism/node.rb', line 14668

def accept(visitor)
  visitor.visit_rescue_modifier_node(self)
end

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array[nil | Node]



14677
14678
14679
 
# File 'lib/prism/node.rb', line 14677

def child_nodes
  [expression, rescue_expression]
end

#comment_targets ⇒ Object

def comment_targets: () -> Array[Node | Location]



14687
14688
14689
 
# File 'lib/prism/node.rb', line 14687

def comment_targets
  [expression, keyword_loc, rescue_expression]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



14682
14683
14684
 
# File 'lib/prism/node.rb', line 14682

def compact_child_nodes
  [expression, rescue_expression]
end

#copy(**params) ⇒ Object

def copy: (**params) -> RescueModifierNode



14692
14693
14694
14695
14696
14697
14698
14699
 
# File 'lib/prism/node.rb', line 14692

def copy(**params)
  RescueModifierNode.new(
    params.fetch(:expression) { expression },
    params.fetch(:keyword_loc) { keyword_loc },
    params.fetch(:rescue_expression) { rescue_expression },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]



14705
14706
14707
 
# File 'lib/prism/node.rb', line 14705

def deconstruct_keys(keys)
  { expression: expression, keyword_loc: keyword_loc, rescue_expression: rescue_expression, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



14715
14716
14717
14718
14719
14720
14721
14722
14723
 
# File 'lib/prism/node.rb', line 14715

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── expression:\n"
  inspector << inspector.child_node(expression, "│   ")
  inspector << "├── keyword_loc: #{inspector.location(keyword_loc)}\n"
  inspector << "└── rescue_expression:\n"
  inspector << inspector.child_node(rescue_expression, "    ")
  inspector.to_str
end

#keyword ⇒ Object

def keyword: () -> String



14710
14711
14712
 
# File 'lib/prism/node.rb', line 14710

def keyword
  keyword_loc.slice
end

#set_newline_flag(newline_marked) ⇒ Object

:nodoc:



14672
14673
14674
 
# File 'lib/prism/node.rb', line 14672

def set_newline_flag(newline_marked) # :nodoc:
  expression.set_newline_flag(newline_marked)
end

#type ⇒ Object

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.

Instead, you can call #type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.

def type: () -> Symbol



14739
14740
14741
 
# File 'lib/prism/node.rb', line 14739

def type
  :rescue_modifier_node
end