Represents the use of the ‘return` keyword.
return 1 ^^^^^^^^
attr_reader keyword_loc: Location
attr_reader arguments: ArgumentsNode?
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 15106
def initialize(keyword_loc, arguments, location)
@keyword_loc = keyword_loc
@arguments = arguments
@location = location
end
def initialize: (keyword_loc: Location, arguments: ArgumentsNode?, location: Location) -> void
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 15193
def self.type
:return_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 15113
def accept(visitor)
visitor.visit_return_node(self)
end
def accept: (visitor: Visitor) -> void
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 15118
def child_nodes
[arguments]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 15130
def comment_targets
[keyword_loc, *arguments]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 15123
def compact_child_nodes
compact = []
compact << arguments if arguments
compact
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 15135
def copy(**params)
ReturnNode.new(
params.fetch(:keyword_loc) { keyword_loc },
params.fetch(:arguments) { arguments },
params.fetch(:location) { location },
)
end
def copy: (**params) -> ReturnNode
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 15147
def deconstruct_keys(keys)
{ keyword_loc: keyword_loc, arguments: arguments, location: location }
end
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 15157
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── keyword_loc: #{inspector.location(keyword_loc)}\n"
if (arguments = self.arguments).nil?
inspector << "└── arguments: ∅\n"
else
inspector << "└── arguments:\n"
inspector << arguments.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 15152
def keyword
keyword_loc.slice
end
def keyword: () -> String
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 15183
def type
:return_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