class Prism::FindPatternNode - Documentation for Ruby 3.4
Description: class Prism::FindPatternNode: Represents a find pattern in pattern matching.
Keywords: ruby,class,Prism::FindPatternNode

# class Prism::FindPatternNode

Represents a find pattern in pattern matching.

    foo in *bar, baz, *qux
           ^^^^^^^^^^^^^^^

    foo in [*bar, baz, *qux]
           ^^^^^^^^^^^^^^^^^

    foo in Foo(*bar, baz, *qux)
           ^^^^^^^^^^^^^^^^^^^^

    foo => *bar, baz, *qux
           ^^^^^^^^^^^^^^^

### Attributes

constant [R]

Represents the optional constant preceding the pattern

    foo in Foo(*bar, baz, *qux)
           ^^^

left [R]

Represents the first wildcard node in the pattern.

    foo in *bar, baz, *qux
           ^^^^

    foo in Foo(*bar, baz, *qux)
               ^^^^

requireds [R]

Represents the nodes in between the wildcards.

    foo in *bar, baz, *qux
                 ^^^

    foo in Foo(*bar, baz, 1, *qux)
                     ^^^^^^

right [R]

Represents the second wildcard node in the pattern.

    foo in *bar, baz, *qux
                      ^^^^

    foo in Foo(*bar, baz, *qux)
                          ^^^^

### Public Class Methods

new (source, node_id, location, flags, constant, left, requireds, right, opening_loc, closing_loc)
Source

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

Initialize a new `FindPatternNode` node.

type ()
Source

    # File lib/prism/node.rb, line 7006
    def self.type
      :find_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 7012
    def ===(other)
      other.is_a?(FindPatternNode) &&
        (constant === other.constant) &&
        (left === other.left) &&
        (requireds.length == other.requireds.length) &&
        requireds.zip(other.requireds).all? { |left, right| left === right } &&
        (right === other.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 6865
    def accept(visitor)
      visitor.visit_find_pattern_node(self)
    end

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

child_nodes ()
Source

    # File lib/prism/node.rb, line 6870
    def child_nodes
      [constant, left, *requireds, right]
    end

def `child_nodes`: () -> Array

Also aliased as: deconstruct
closing ()
Source

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

def closing: () -> `String`?

closing_loc ()
Source

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

The location of the closing brace.

    foo in [*bar, baz, *qux]
                           ^

    foo in Foo(*bar, baz, *qux)
                              ^

comment_targets ()
Source

    # File lib/prism/node.rb, line 6885
    def comment_targets
      [*constant, left, *requireds, right, *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 6875
    def compact_child_nodes
      compact = [] #: Array[Prism::node]
      compact << constant if constant
      compact << left
      compact.concat(requireds)
      compact << right
      compact
    end

def `compact_child_nodes`: () -> Array

copy (node_id: self.node_id, location: self.location, flags: self.flags, constant: self.constant, left: self.left, requireds: self.requireds, right: self.right, opening_loc: self.opening_loc, closing_loc: self.closing_loc)
Source

    # File lib/prism/node.rb, line 6890
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, constant: self.constant, left: self.left, requireds: self.requireds, right: self.right, opening_loc: self.opening_loc, closing_loc: self.closing_loc)
      FindPatternNode.new(source, node_id, location, flags, constant, left, requireds, right, opening_loc, closing_loc)
    end

def copy: (?node_id: `Integer`, ?location: `Location`, ?flags: `Integer`, ?constant: `ConstantPathNode` | `ConstantReadNode` | nil, ?left: `SplatNode`, ?requireds: Array, ?right: `SplatNode` | `MissingNode`, ?opening_loc: `Location`?, ?closing_loc: `Location`?) -> `FindPatternNode`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

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

def `deconstruct_keys`: (Array keys) -> { node_id: `Integer`, location: `Location`, constant: `ConstantPathNode` | `ConstantReadNode` | nil, left: `SplatNode`, requireds: Array, right: `SplatNode` | `MissingNode`, `opening_loc`: `Location`?, `closing_loc`: `Location`? }

inspect ()
Source

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

def inspect -> `String`

opening ()
Source

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

def opening: () -> `String`?

opening_loc ()
Source

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

The location of the opening brace.

    foo in [*bar, baz, *qux]
           ^

    foo in Foo(*bar, baz, *qux)
              ^

save_closing_loc (repository)
Source

    # File lib/prism/node.rb, line 6981
    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 6956
    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 7001
    def type
      :find_pattern_node
    end

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