Represents the use of the ‘while` keyword, either in the block form or the modifier form.
bar while foo ^^^^^^^^^^^^^ while foo do bar end ^^^^^^^^^^^^^^^^^^^^
attr_reader predicate: Prism::node
attr_reader statements: StatementsNode?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18558
def initialize(source, flags, keyword_loc, closing_loc, predicate, statements, location)
@source = source
@location = location
@flags = flags
@keyword_loc = keyword_loc
@closing_loc = closing_loc
@predicate = predicate
@statements = statements
end
def initialize: (Integer flags, Location keyword_loc, Location? closing_loc, Prism::node predicate, StatementsNode? statements, Location location) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18678
def self.type
:while_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 18684
def ===(other)
other.is_a?(WhileNode) &&
(flags === other.flags) &&
(keyword_loc.nil? == other.keyword_loc.nil?) &&
(closing_loc.nil? == other.closing_loc.nil?) &&
(predicate === other.predicate) &&
(statements === other.statements)
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 18569
def accept(visitor)
visitor.visit_while_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18635
def begin_modifier?
flags.anybits?(LoopFlags::BEGIN_MODIFIER)
end
def begin_modifier?: () -> bool
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18574
def child_nodes
[predicate, statements]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18645
def closing
closing_loc&.slice
end
def closing: () -> String?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18616
def closing_loc
location = @closing_loc
case location
when nil
nil
when Location
location
else
@closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
end
attr_reader closing_loc: Location?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18587
def comment_targets
[keyword_loc, *closing_loc, predicate, *statements] #: Array[Prism::node | Location]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18579
def compact_child_nodes
compact = [] #: Array[Prism::node]
compact << predicate
compact << statements if statements
compact
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18592
def copy(flags: self.flags, keyword_loc: self.keyword_loc, closing_loc: self.closing_loc, predicate: self.predicate, statements: self.statements, location: self.location)
WhileNode.new(source, flags, keyword_loc, closing_loc, predicate, statements, location)
end
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18600
def deconstruct_keys(keys)
{ flags: flags, keyword_loc: keyword_loc, closing_loc: closing_loc, predicate: predicate, statements: statements, location: location }
end
def deconstruct_keys: (Array keys) -> { flags: Integer, keyword_loc: Location, closing_loc: Location?, predicate: Prism::node, statements: StatementsNode?, location: Location }
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18650
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18640
def keyword
keyword_loc.slice
end
def keyword: () -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18609
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 18668
def type
:while_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