Represents an array pattern in pattern matching.
foo in 1, 2 ^^^^^^^^^^^ foo in [1, 2] ^^^^^^^^^^^^^ foo in *1 ^^^^^^^^^ foo in Bar[] ^^^^^^^^^^^^ foo in Bar[1, 2, 3] ^^^^^^^^^^^^^^^^^^^
attr_reader constant: Prism::node?
attr_reader rest: Prism::node?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 903
def initialize(source, constant, requireds, rest, posts, opening_loc, closing_loc, location)
@source = source
@location = location
@constant = constant
@requireds = requireds
@rest = rest
@posts = posts
@opening_loc = opening_loc
@closing_loc = closing_loc
end
def initialize: (Prism::node? constant, Array requireds, Prism::node? rest, Array posts, Location? opening_loc, Location? closing_loc, Location location) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 1029
def self.type
:array_pattern_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 1035
def ===(other)
other.is_a?(ArrayPatternNode) &&
(constant === other.constant) &&
(requireds.length == other.requireds.length) &&
requireds.zip(other.requireds).all? { |left, right| left === right } &&
(rest === other.rest) &&
(posts.length == other.posts.length) &&
posts.zip(other.posts).all? { |left, right| left === right } &&
(opening_loc.nil? == other.opening_loc.nil?) &&
(closing_loc.nil? == other.closing_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 915
def accept(visitor)
visitor.visit_array_pattern_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 920
def child_nodes
[constant, *requireds, rest, *posts]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 996
def closing
closing_loc&.slice
end
def closing: () -> String?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 978
def closing_loc
location = @closing_loc
case location
when nil
nil
when Location
location
else
@closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
end
attr_reader closing_loc: Location?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 935
def comment_targets
[*constant, *requireds, *rest, *posts, *opening_loc, *closing_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 925
def compact_child_nodes
compact = [] #: Array[Prism::node]
compact << constant if constant
compact.concat(requireds)
compact << rest if rest
compact.concat(posts)
compact
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 940
def copy(constant: self.constant, requireds: self.requireds, rest: self.rest, posts: self.posts, opening_loc: self.opening_loc, closing_loc: self.closing_loc, location: self.location)
ArrayPatternNode.new(source, constant, requireds, rest, posts, opening_loc, closing_loc, location)
end
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 948
def deconstruct_keys(keys)
{ constant: constant, requireds: requireds, rest: rest, posts: posts, opening_loc: opening_loc, closing_loc: closing_loc, location: location }
end
def deconstruct_keys: (Array keys) -> { constant: Prism::node?, requireds: Array, rest: Prism::node?, posts: Array, opening_loc: Location?, closing_loc: Location?, location: Location }
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 1001
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 991
def opening
opening_loc&.slice
end
def opening: () -> String?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 965
def opening_loc
location = @opening_loc
case location
when nil
nil
when Location
location
else
@opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
end
attr_reader opening_loc: Location?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 1019
def type
:array_pattern_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