Represents the use of the ‘yield` keyword.
yield 1 ^^^^^^^
attr_reader arguments: ArgumentsNode?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18847
def initialize(source, keyword_loc, lparen_loc, arguments, rparen_loc, location)
@source = source
@location = location
@keyword_loc = keyword_loc
@lparen_loc = lparen_loc
@arguments = arguments
@rparen_loc = rparen_loc
end
def initialize: (Location keyword_loc, Location? lparen_loc, ArgumentsNode? arguments, Location? rparen_loc, Location location) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18971
def self.type
:yield_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 18977
def ===(other)
other.is_a?(YieldNode) &&
(keyword_loc.nil? == other.keyword_loc.nil?) &&
(lparen_loc.nil? == other.lparen_loc.nil?) &&
(arguments === other.arguments) &&
(rparen_loc.nil? == other.rparen_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 18857
def accept(visitor)
visitor.visit_yield_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18862
def child_nodes
[arguments]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18874
def comment_targets
[keyword_loc, *lparen_loc, *arguments, *rparen_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 18867
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 18879
def copy(keyword_loc: self.keyword_loc, lparen_loc: self.lparen_loc, arguments: self.arguments, rparen_loc: self.rparen_loc, location: self.location)
YieldNode.new(source, keyword_loc, lparen_loc, arguments, rparen_loc, location)
end
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18887
def deconstruct_keys(keys)
{ keyword_loc: keyword_loc, lparen_loc: lparen_loc, arguments: arguments, rparen_loc: rparen_loc, location: location }
end
def deconstruct_keys: (Array keys) -> { keyword_loc: Location, lparen_loc: Location?, arguments: ArgumentsNode?, rparen_loc: Location?, location: Location }
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18943
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18928
def keyword
keyword_loc.slice
end
def keyword: () -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18892
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 18933
def lparen
lparen_loc&.slice
end
def lparen: () -> String?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18899
def lparen_loc
location = @lparen_loc
case location
when nil
nil
when Location
location
else
@lparen_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
end
attr_reader lparen_loc: Location?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18938
def rparen
rparen_loc&.slice
end
def rparen: () -> String?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18915
def rparen_loc
location = @rparen_loc
case location
when nil
nil
when Location
location
else
@rparen_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
end
attr_reader rparen_loc: Location?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18961
def type
:yield_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