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 exceptions: Array
attr_reader reference: Prism::node?
attr_reader statements: StatementsNode?
attr_reader consequent: RescueNode?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 16111
def initialize(source, keyword_loc, exceptions, operator_loc, reference, statements, consequent, location)
@source = source
@location = location
@keyword_loc = keyword_loc
@exceptions = exceptions
@operator_loc = operator_loc
@reference = reference
@statements = statements
@consequent = consequent
end
def initialize: (Location keyword_loc, Array exceptions, Location? operator_loc, Prism::node? reference, StatementsNode? statements, RescueNode? consequent, Location location) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 16231
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.4.0-preview1/lib/prism/node.rb, line 16237
def ===(other)
other.is_a?(RescueNode) &&
(keyword_loc.nil? == other.keyword_loc.nil?) &&
(exceptions.length == other.exceptions.length) &&
exceptions.zip(other.exceptions).all? { |left, right| left === right } &&
(operator_loc.nil? == other.operator_loc.nil?) &&
(reference === other.reference) &&
(statements === other.statements) &&
(consequent === other.consequent)
end
Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 16123
def accept(visitor)
visitor.visit_rescue_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 16128
def child_nodes
[*exceptions, reference, statements, consequent]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 16143
def comment_targets
[keyword_loc, *exceptions, *operator_loc, *reference, *statements, *consequent] #: Array[Prism::node | Location]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 16133
def compact_child_nodes
compact = [] #: Array[Prism::node]
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.4.0-preview1/lib/prism/node.rb, line 16148
def copy(keyword_loc: self.keyword_loc, exceptions: self.exceptions, operator_loc: self.operator_loc, reference: self.reference, statements: self.statements, consequent: self.consequent, location: self.location)
RescueNode.new(source, keyword_loc, exceptions, operator_loc, reference, statements, consequent, location)
end
def copy: (?keyword_loc: Location, ?exceptions: Array, ?operator_loc: Location?, ?reference: Prism::node?, ?statements: StatementsNode?, ?consequent: RescueNode?, ?location: Location) -> RescueNode
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 16156
def deconstruct_keys(keys)
{ keyword_loc: keyword_loc, exceptions: exceptions, operator_loc: operator_loc, reference: reference, statements: statements, consequent: consequent, location: location }
end
def deconstruct_keys: (Array keys) -> { keyword_loc: Location, exceptions: Array, operator_loc: Location?, reference: Prism::node?, statements: StatementsNode?, consequent: RescueNode?, location: Location }
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 16203
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 16193
def keyword
keyword_loc.slice
end
def keyword: () -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 16161
def keyword_loc
location = @keyword_loc
return location if location.is_a?(Location)
@keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
attr_reader keyword_loc: Location
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 16198
def operator
operator_loc&.slice
end
def operator: () -> String?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 16171
def operator_loc
location = @operator_loc
case location
when nil
nil
when Location
location
else
@operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
end
attr_reader operator_loc: Location?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 16221
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