Represents the use of the ‘break` keyword.
break foo ^^^^^^^^^
The arguments to the break statement, if present. These can be any [non-void expressions](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression).
break foo
^^^
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2149
def initialize(source, arguments, keyword_loc, location)
@source = source
@location = location
@arguments = arguments
@keyword_loc = keyword_loc
end
def initialize: (ArgumentsNode? arguments, Location keyword_loc, Location location) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2241
def self.type
:break_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 2247
def ===(other)
other.is_a?(BreakNode) &&
(arguments === other.arguments) &&
(keyword_loc.nil? == other.keyword_loc.nil?)
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 2157
def accept(visitor)
visitor.visit_break_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2162
def child_nodes
[arguments]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2174
def comment_targets
[*arguments, keyword_loc] #: Array[Prism::node | Location]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2167
def compact_child_nodes
compact = [] #: Array[Prism::node]
compact << arguments if arguments
compact
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2179
def copy(arguments: self.arguments, keyword_loc: self.keyword_loc, location: self.location)
BreakNode.new(source, arguments, keyword_loc, location)
end
def copy: (?arguments: ArgumentsNode?, ?keyword_loc: Location, ?location: Location) -> BreakNode
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2187
def deconstruct_keys(keys)
{ arguments: arguments, keyword_loc: keyword_loc, location: location }
end
def deconstruct_keys: (Array keys) -> { arguments: ArgumentsNode?, keyword_loc: Location, location: Location }
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2213
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2208
def keyword
keyword_loc.slice
end
def keyword: () -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2201
def keyword_loc
location = @keyword_loc
return location if location.is_a?(Location)
@keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
The location of the ‘break` keyword.
break foo ^^^^^
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2231
def type
:break_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