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.
attr_reader keyword_loc: Location
attr_reader exceptions: Array
attr_reader operator_loc: Location?
attr_reader statements: StatementsNode?
attr_reader consequent: RescueNode?
# File tmp/rubies/ruby-3.3.0/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
def initialize: (keyword_loc: Location, exceptions: Array, operator_loc: Location?, reference: Node?, statements: StatementsNode?, consequent: RescueNode?, location: Location) -> void
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 14901
def self.type
:rescue_node
end
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
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 14795
def accept(visitor)
visitor.visit_rescue_node(self)
end
def accept: (visitor: Visitor) -> void
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 14800
def child_nodes
[*exceptions, reference, statements, consequent]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 14815
def comment_targets
[keyword_loc, *exceptions, *operator_loc, *reference, *statements, *consequent]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.3.0/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
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.3.0/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
def copy: (**params) -> RescueNode
# File tmp/rubies/ruby-3.3.0/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
# File tmp/rubies/ruby-3.3.0/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
def inspect(inspector: NodeInspector) -> String
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 14841
def keyword
keyword_loc.slice
end
def keyword: () -> String
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 14846
def operator
operator_loc&.slice
end
def operator: () -> String?
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 14891
def type
:rescue_node
end
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