Class: Prism::RescueNode

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

Overview

Represents a rescue statement.

begin
rescue Foo, *splat, Bar => ex
  foo
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
end

‘Foo, *splat, Bar` are in the `exceptions` field. `ex` is in the `exception` field.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(keyword_loc, exceptions, operator_loc, reference, statements, consequent, location) ⇒ RescueNode

def initialize: (keyword_loc: Location, exceptions: Array, operator_loc: Location?, reference: Node?, statements: StatementsNode?, consequent: RescueNode?, location: Location) -> void



14784
14785
14786
14787
14788
14789
14790
14791
14792
 
# File 'lib/prism/node.rb', line 14784

def initialize(keyword_loc, exceptions, operator_loc, reference, statements, consequent, location)
  @keyword_loc = keyword_loc
  @exceptions = exceptions
  @operator_loc = operator_loc
  @reference = reference
  @statements = statements
  @consequent = consequent
  @location = location
end

Instance Attribute Details

#consequent ⇒ Object (readonly)

attr_reader consequent: RescueNode?



14781
14782
14783
 
# File 'lib/prism/node.rb', line 14781

def consequent
  @consequent
end

#exceptions ⇒ Object (readonly)

attr_reader exceptions: Array



14769
14770
14771
 
# File 'lib/prism/node.rb', line 14769

def exceptions
  @exceptions
end

#keyword_loc ⇒ Object (readonly)

attr_reader keyword_loc: Location



14766
14767
14768
 
# File 'lib/prism/node.rb', line 14766

def keyword_loc
  @keyword_loc
end

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location?



14772
14773
14774
 
# File 'lib/prism/node.rb', line 14772

def operator_loc
  @operator_loc
end

#reference ⇒ Object (readonly)

attr_reader reference: Node?



14775
14776
14777
 
# File 'lib/prism/node.rb', line 14775

def reference
  @reference
end

#statements ⇒ Object (readonly)

attr_reader statements: StatementsNode?



14778
14779
14780
 
# File 'lib/prism/node.rb', line 14778

def statements
  @statements
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



14901
14902
14903
 
# File 'lib/prism/node.rb', line 14901

def self.type
  :rescue_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



14795
14796
14797
 
# File 'lib/prism/node.rb', line 14795

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

#child_nodes ⇒ Object Also known as: deconstruct

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



14800
14801
14802
 
# File 'lib/prism/node.rb', line 14800

def child_nodes
  [*exceptions, reference, statements, consequent]
end

#comment_targets ⇒ Object

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



14815
14816
14817
 
# File 'lib/prism/node.rb', line 14815

def comment_targets
  [keyword_loc, *exceptions, *operator_loc, *reference, *statements, *consequent]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



14805
14806
14807
14808
14809
14810
14811
14812
 
# File 'lib/prism/node.rb', line 14805

def compact_child_nodes
  compact = []
  compact.concat(exceptions)
  compact << reference if reference
  compact << statements if statements
  compact << consequent if consequent
  compact
end

#copy(**params) ⇒ Object

def copy: (**params) -> RescueNode



14820
14821
14822
14823
14824
14825
14826
14827
14828
14829
14830
 
# File 'lib/prism/node.rb', line 14820

def copy(**params)
  RescueNode.new(
    params.fetch(:keyword_loc) { keyword_loc },
    params.fetch(:exceptions) { exceptions },
    params.fetch(:operator_loc) { operator_loc },
    params.fetch(:reference) { reference },
    params.fetch(:statements) { statements },
    params.fetch(:consequent) { consequent },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



14836
14837
14838
 
# File 'lib/prism/node.rb', line 14836

def deconstruct_keys(keys)
  { keyword_loc: keyword_loc, exceptions: exceptions, operator_loc: operator_loc, reference: reference, statements: statements, consequent: consequent, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



14851
14852
14853
14854
14855
14856
14857
14858
14859
14860
14861
14862
14863
14864
14865
14866
14867
14868
14869
14870
14871
14872
14873
14874
14875
 
# File 'lib/prism/node.rb', line 14851

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── keyword_loc: #{inspector.location(keyword_loc)}\n"
  inspector << "├── exceptions: #{inspector.list("#{inspector.prefix}│   ", exceptions)}"
  inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
  if (reference = self.reference).nil?
    inspector << "├── reference: ∅\n"
  else
    inspector << "├── reference:\n"
    inspector << reference.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  if (statements = self.statements).nil?
    inspector << "├── statements: ∅\n"
  else
    inspector << "├── statements:\n"
    inspector << statements.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  if (consequent = self.consequent).nil?
    inspector << "└── consequent: ∅\n"
  else
    inspector << "└── consequent:\n"
    inspector << consequent.inspect(inspector.child_inspector("    ")).delete_prefix(inspector.prefix)
  end
  inspector.to_str
end

#keyword ⇒ Object

def keyword: () -> String



14841
14842
14843
 
# File 'lib/prism/node.rb', line 14841

def keyword
  keyword_loc.slice
end

#operator ⇒ Object

def operator: () -> String?



14846
14847
14848
 
# File 'lib/prism/node.rb', line 14846

def operator
  operator_loc&.slice
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



14891
14892
14893
 
# File 'lib/prism/node.rb', line 14891

def type
  :rescue_node
end