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 keyword_loc: Location
attr_reader closing_loc: Location?
attr_reader statements: StatementsNode?
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 16896
def initialize(flags, keyword_loc, closing_loc, predicate, statements, location)
@flags = flags
@keyword_loc = keyword_loc
@closing_loc = closing_loc
@predicate = predicate
@statements = statements
@location = location
end
def initialize: (flags: Integer, keyword_loc: Location, closing_loc: Location?, predicate: Node, statements: StatementsNode?, location: Location) -> void
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 17009
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.3.0/lib/prism/node.rb, line 16906
def accept(visitor)
visitor.visit_while_node(self)
end
def accept: (visitor: Visitor) -> void
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 16953
def begin_modifier?
flags.anybits?(LoopFlags::BEGIN_MODIFIER)
end
def begin_modifier?: () -> bool
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 16915
def child_nodes
[predicate, statements]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 16963
def closing
closing_loc&.slice
end
def closing: () -> String?
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 16928
def comment_targets
[keyword_loc, *closing_loc, predicate, *statements]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 16920
def compact_child_nodes
compact = []
compact << predicate
compact << statements if statements
compact
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 16933
def copy(**params)
WhileNode.new(
params.fetch(:flags) { flags },
params.fetch(:keyword_loc) { keyword_loc },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:predicate) { predicate },
params.fetch(:statements) { statements },
params.fetch(:location) { location },
)
end
def copy: (**params) -> WhileNode
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 16948
def deconstruct_keys(keys)
{ flags: flags, keyword_loc: keyword_loc, closing_loc: closing_loc, predicate: predicate, statements: statements, location: location }
end
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 16968
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("begin_modifier" if begin_modifier?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
inspector << "├── keyword_loc: #{inspector.location(keyword_loc)}\n"
inspector << "├── closing_loc: #{inspector.location(closing_loc)}\n"
inspector << "├── predicate:\n"
inspector << inspector.child_node(predicate, "│ ")
if (statements = self.statements).nil?
inspector << "└── statements: ∅\n"
else
inspector << "└── statements:\n"
inspector << statements.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 16958
def keyword
keyword_loc.slice
end
def keyword: () -> String
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 16999
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