Represents a set of arguments to a method or a keyword.
return foo, bar, baz
^^^^^^^^^^^^^
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 480
def initialize(flags, arguments, location)
@flags = flags
@arguments = arguments
@location = location
end
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 561
def self.type
:arguments_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 487
def accept(visitor)
visitor.visit_arguments_node(self)
end
def accept: (visitor: Visitor) -> void
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 492
def child_nodes
[*arguments]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 502
def comment_targets
[*arguments]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 497
def compact_child_nodes
[*arguments]
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 524
def contains_keyword_splat?
flags.anybits?(ArgumentsNodeFlags::CONTAINS_KEYWORD_SPLAT)
end
def contains_keyword_splat?: () -> bool
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 507
def copy(**params)
ArgumentsNode.new(
params.fetch(:flags) { flags },
params.fetch(:arguments) { arguments },
params.fetch(:location) { location },
)
end
def copy: (**params) -> ArgumentsNode
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 519
def deconstruct_keys(keys)
{ flags: flags, arguments: arguments, location: location }
end
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 529
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("contains_keyword_splat" if contains_keyword_splat?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
inspector << "└── arguments: #{inspector.list("#{inspector.prefix} ", arguments)}"
inspector.to_str
end
def inspect(inspector: NodeInspector) -> String
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 551
def type
:arguments_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