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

🔍

No recent searches

# 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
           ^^^^^^^^^^^^^^^

### Public Class Methods

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

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

### Public Instance Methods

constant → ConstantPathNode | ConstantReadNode | nil
Source

    # File lib/prism/node.rb, line 11688
    def constant
      @constant
    end

Represents the optional constant preceding the pattern

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

left → SplatNode
Source

    # File lib/prism/node.rb, line 11704
    def left
      @left
    end

Represents the first wildcard node in the pattern.

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

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

requireds → Array[Node]
Source

    # File lib/prism/node.rb, line 11720
    def requireds
      @requireds
    end

Represents the nodes in between the wildcards.

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

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

right → SplatNode
Source

    # File lib/prism/node.rb, line 11736
    def right
      @right
    end

Represents the second wildcard node in the pattern.

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

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

## Locations

### Public Instance Methods

closing_loc → Location | nil
Source

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

opening_loc → Location | nil
Source

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

## Node Interface

These methods are present on all subclasses of `Node`. Read the node interface docs for more information.

### Public Class Methods

type ()
Source

    # File lib/prism/node.rb, line 11668
    def self.type
      :find_pattern_node
    end

See `Node.type`.

### Public Instance Methods

accept (visitor)
Source

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

See `Node.accept`.

child_nodes ()
Source

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

See `Node.child_nodes`.

Also aliased as: deconstruct
comment_targets ()
Source

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

See `Node.comment_targets`.

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 11625
    def compact_child_nodes
      compact = [] #: Array[Prism::node]
      if (constant = self.constant); compact << constant; end
      compact << left
      compact.concat(requireds)
      compact << right
      compact
    end

See `Node.compact_child_nodes`.

copy(**fields) → FindPatternNode
Source

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

Creates a copy of self with the given fields, using self as the template.

deconstruct ()
Alias for: child_nodes
each_child_node () { |constant| ... }
Source

    # File lib/prism/node.rb, line 11613
    def each_child_node(&blk)
      return to_enum(:each_child_node) unless block_given?

      if (constant = self.constant); yield constant; end
      yield left
      requireds.each { |node| yield node }
      yield right
    end

See `Node.each_child_node`.

type ()
Source

    # File lib/prism/node.rb, line 11661
    def type
      :find_pattern_node
    end

See `Node#type`.

## Repository

Methods related to `Relocation`.

### Public Instance Methods

save_closing_loc (repository)
Source

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

## Slicing

### Public Instance Methods

closing → String | nil
Source

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

Slice the location of `closing_loc` from the source.

opening → String | nil
Source

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

Slice the location of `opening_loc` from the source.