Represents a set of arguments to a method or a keyword.
return foo, bar, baz
^^^^^^^^^^^^^
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 634
def initialize(source, flags, arguments, location)
@source = source
@location = location
@flags = flags
@arguments = arguments
end
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 720
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.4.0-preview1/lib/prism/node.rb, line 726
def ===(other)
other.is_a?(ArgumentsNode) &&
(flags === other.flags) &&
(arguments.length == other.arguments.length) &&
arguments.zip(other.arguments).all? { |left, right| left === right }
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 642
def accept(visitor)
visitor.visit_arguments_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 647
def child_nodes
[*arguments]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 657
def comment_targets
[*arguments] #: Array[Prism::node | Location]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 652
def compact_child_nodes
[*arguments]
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 687
def contains_keyword_splat?
flags.anybits?(ArgumentsNodeFlags::CONTAINS_KEYWORD_SPLAT)
end
def contains_keyword_splat?: () -> bool
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 682
def contains_keywords?
flags.anybits?(ArgumentsNodeFlags::CONTAINS_KEYWORDS)
end
def contains_keywords?: () -> bool
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 662
def copy(flags: self.flags, arguments: self.arguments, location: self.location)
ArgumentsNode.new(source, flags, arguments, location)
end
def copy: (?flags: Integer, ?arguments: Array, ?location: Location) -> ArgumentsNode
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 670
def deconstruct_keys(keys)
{ flags: flags, arguments: arguments, location: location }
end
def deconstruct_keys: (Array keys) -> { flags: Integer, arguments: Array, location: Location }
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 692
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 710
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