Represents an ‘ensure` clause in a `begin` statement.
begin foo ensure ^^^^^^ bar end
attr_reader ensure_keyword_loc: Location
attr_reader statements: StatementsNode?
attr_reader end_keyword_loc: Location
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 5907
def initialize(ensure_keyword_loc, statements, end_keyword_loc, location)
@ensure_keyword_loc = ensure_keyword_loc
@statements = statements
@end_keyword_loc = end_keyword_loc
@location = location
end
def initialize: (ensure_keyword_loc: Location, statements: StatementsNode?, end_keyword_loc: Location, location: Location) -> void
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 6002
def self.type
:ensure_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 5915
def accept(visitor)
visitor.visit_ensure_node(self)
end
def accept: (visitor: Visitor) -> void
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 5920
def child_nodes
[statements]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 5932
def comment_targets
[ensure_keyword_loc, *statements, end_keyword_loc]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 5925
def compact_child_nodes
compact = []
compact << statements if statements
compact
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 5937
def copy(**params)
EnsureNode.new(
params.fetch(:ensure_keyword_loc) { ensure_keyword_loc },
params.fetch(:statements) { statements },
params.fetch(:end_keyword_loc) { end_keyword_loc },
params.fetch(:location) { location },
)
end
def copy: (**params) -> EnsureNode
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 5950
def deconstruct_keys(keys)
{ ensure_keyword_loc: ensure_keyword_loc, statements: statements, end_keyword_loc: end_keyword_loc, location: location }
end
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 5960
def end_keyword
end_keyword_loc.slice
end
def end_keyword: () -> String
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 5955
def ensure_keyword
ensure_keyword_loc.slice
end
def ensure_keyword: () -> String
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 5965
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── ensure_keyword_loc: #{inspector.location(ensure_keyword_loc)}\n"
if (statements = self.statements).nil?
inspector << "├── statements: ∅\n"
else
inspector << "├── statements:\n"
inspector << statements.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "└── end_keyword_loc: #{inspector.location(end_keyword_loc)}\n"
inspector.to_str
end
def inspect(inspector: NodeInspector) -> String
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 5992
def type
:ensure_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