class Prism::EnsureNode
Represents an ‘ensure` clause in a `begin` statement.
begin foo ensure ^^^^^^ bar end
Attributes
attr_reader statements: StatementsNode
?
Public Class Methods
def initialize: (Location
ensure_keyword_loc
, StatementsNode
? statements, Location
end_keyword_loc
, Location
location) -> void
# File lib/prism/node.rb, line 6427 def initialize(source, ensure_keyword_loc, statements, end_keyword_loc, location) @source = source @newline = false @location = location @ensure_keyword_loc = ensure_keyword_loc @statements = statements @end_keyword_loc = end_keyword_loc 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 lib/prism/node.rb, line 6537 def self.type :ensure_node end
Public Instance Methods
def accept: (Visitor
visitor) -> void
# File lib/prism/node.rb, line 6437 def accept(visitor) visitor.visit_ensure_node(self) end
def child_nodes
: () -> Array[nil | Node]
# File lib/prism/node.rb, line 6442 def child_nodes [statements] end
def comment_targets
: () -> Array[Node | Location]
# File lib/prism/node.rb, line 6454 def comment_targets [ensure_keyword_loc, *statements, end_keyword_loc] #: Array[Prism::node | Location] end
def compact_child_nodes
: () -> Array
# File lib/prism/node.rb, line 6447 def compact_child_nodes compact = [] #: Array[Prism::node] compact << statements if statements compact end
def copy: (?ensure_keyword_loc: Location
, ?statements: StatementsNode
?, ?end_keyword_loc: Location
, ?location: Location
) -> EnsureNode
# File lib/prism/node.rb, line 6459 def copy(ensure_keyword_loc: self.ensure_keyword_loc, statements: self.statements, end_keyword_loc: self.end_keyword_loc, location: self.location) EnsureNode.new(source, ensure_keyword_loc, statements, end_keyword_loc, location) end
def deconstruct_keys
: (Array keys) -> { ensure_keyword_loc
: Location
, statements: StatementsNode
?, end_keyword_loc
: Location
, location: Location
}
# File lib/prism/node.rb, line 6467 def deconstruct_keys(keys) { ensure_keyword_loc: ensure_keyword_loc, statements: statements, end_keyword_loc: end_keyword_loc, location: location } end
def end_keyword
: () -> String
# File lib/prism/node.rb, line 6495 def end_keyword end_keyword_loc.slice end
attr_reader end_keyword_loc
: Location
# File lib/prism/node.rb, line 6482 def end_keyword_loc location = @end_keyword_loc return location if location.is_a?(Location) @end_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF) end
def ensure_keyword
: () -> String
# File lib/prism/node.rb, line 6490 def ensure_keyword ensure_keyword_loc.slice end
attr_reader ensure_keyword_loc
: Location
# File lib/prism/node.rb, line 6472 def ensure_keyword_loc location = @ensure_keyword_loc return location if location.is_a?(Location) @ensure_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF) end
def inspect(NodeInspector inspector) -> String
# File lib/prism/node.rb, line 6500 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
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
# File lib/prism/node.rb, line 6527 def type :ensure_node end