class Prism::ArrayPatternNode - Documentation for Ruby 3.4
Description: class Prism::ArrayPatternNode: Represents an array pattern in pattern matching.
Keywords: ruby,class,Prism::ArrayPatternNode

# class Prism::ArrayPatternNode

Represents an array pattern in pattern matching.

    foo in 1, 2
    ^^^^^^^^^^^

    foo in [1, 2]
    ^^^^^^^^^^^^^

    foo in *bar
    ^^^^^^^^^^^

    foo in Bar[]
    ^^^^^^^^^^^^

    foo in Bar[1, 2, 3]
    ^^^^^^^^^^^^^^^^^^^

### Attributes

constant [R]

Represents the optional constant preceding the `Array`

    foo in Bar[]
           ^^^

    foo in Bar[1, 2, 3]
           ^^^

    foo in Bar::Baz[1, 2, 3]
           ^^^^^^^^

posts [R]

Represents the elements after the rest element of the array pattern.

    foo in *bar, baz
                 ^^^

requireds [R]

Represents the required elements of the array pattern.

    foo in [1, 2]
            ^  ^

rest [R]

Represents the rest element of the array pattern.

    foo in *bar
           ^^^^

### Public Class Methods

new (source, node_id, location, flags, constant, requireds, rest, posts, opening_loc, closing_loc)
Source

    # File lib/prism/node.rb, line 1024
    def initialize(source, node_id, location, flags, constant, requireds, rest, posts, opening_loc, closing_loc)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @constant = constant
      @requireds = requireds
      @rest = rest
      @posts = posts
      @opening_loc = opening_loc
      @closing_loc = closing_loc
    end

Initialize a new `ArrayPatternNode` node.

type ()
Source

    # File lib/prism/node.rb, line 1170
    def self.type
      :array_pattern_node
    end

Return a symbol representation of this node type. See `Node::type`.

### Public Instance Methods

=== (other)
Source

    # File lib/prism/node.rb, line 1176
    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.

accept (visitor)
Source

    # File lib/prism/node.rb, line 1038
    def accept(visitor)
      visitor.visit_array_pattern_node(self)
    end

def accept: (`Visitor` visitor) -> void

child_nodes ()
Source

    # File lib/prism/node.rb, line 1043
    def child_nodes
      [constant, *requireds, rest, *posts]
    end

def `child_nodes`: () -> Array

Also aliased as: deconstruct
closing ()
Source

    # File lib/prism/node.rb, line 1155
    def closing
      closing_loc&.slice
    end

def closing: () -> `String`?

closing_loc ()
Source

    # File lib/prism/node.rb, line 1131
    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

Represents the closing location of the array pattern.

    foo in [1, 2]
                ^

comment_targets ()
Source

    # File lib/prism/node.rb, line 1058
    def comment_targets
      [*constant, *requireds, *rest, *posts, *opening_loc, *closing_loc] #: Array[Prism::node | Location]
    end

def `comment_targets`: () -> Array[Node | Location]

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 1048
    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

copy (node_id: self.node_id, location: self.location, flags: self.flags, constant: self.constant, requireds: self.requireds, rest: self.rest, posts: self.posts, opening_loc: self.opening_loc, closing_loc: self.closing_loc)
Source

    # File lib/prism/node.rb, line 1063
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, constant: self.constant, requireds: self.requireds, rest: self.rest, posts: self.posts, opening_loc: self.opening_loc, closing_loc: self.closing_loc)
      ArrayPatternNode.new(source, node_id, location, flags, constant, requireds, rest, posts, opening_loc, closing_loc)
    end

def copy: (?node_id: `Integer`, ?location: `Location`, ?flags: `Integer`, ?constant: `ConstantPathNode` | `ConstantReadNode` | nil, ?requireds: Array, ?rest: Prism::node?, ?posts: Array, ?opening_loc: `Location`?, ?closing_loc: `Location`?) -> `ArrayPatternNode`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

    # File lib/prism/node.rb, line 1071
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, constant: constant, requireds: requireds, rest: rest, posts: posts, opening_loc: opening_loc, closing_loc: closing_loc }
    end

def `deconstruct_keys`: (Array keys) -> { node_id: `Integer`, location: `Location`, constant: `ConstantPathNode` | `ConstantReadNode` | nil, requireds: Array, rest: Prism::node?, posts: Array, `opening_loc`: `Location`?, `closing_loc`: `Location`? }

inspect ()
Source

    # File lib/prism/node.rb, line 1160
    def inspect
      InspectVisitor.compose(self)
    end

def inspect -> `String`

opening ()
Source

    # File lib/prism/node.rb, line 1150
    def opening
      opening_loc&.slice
    end

def opening: () -> `String`?

opening_loc ()
Source

    # File lib/prism/node.rb, line 1109
    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

Represents the opening location of the array pattern.

    foo in [1, 2]
           ^

save_closing_loc (repository)
Source

    # File lib/prism/node.rb, line 1145
    def save_closing_loc(repository)
      repository.enter(node_id, :closing_loc) unless @closing_loc.nil?
    end

Save the `closing_loc` location using the given saved source so that it can be retrieved later.

save_opening_loc (repository)
Source

    # File lib/prism/node.rb, line 1123
    def save_opening_loc(repository)
      repository.enter(node_id, :opening_loc) unless @opening_loc.nil?
    end

Save the `opening_loc` location using the given saved source so that it can be retrieved later.

type ()
Source

    # File lib/prism/node.rb, line 1165
    def type
      :array_pattern_node
    end

Return a symbol representation of this node type. See `Node#type`.