class Prism::NumberedReferenceReadNode - Documentation for Ruby 4.0
Description: class Prism::NumberedReferenceReadNode: Represents reading a numbered reference to a capture in the previous match.
Keywords: ruby,class,Prism::NumberedReferenceReadNode

🔍

No recent searches

# class Prism::NumberedReferenceReadNode

Represents reading a numbered reference to a capture in the previous match.

    $1
    ^^

### Attributes

number [R]

The (1-indexed, from the left) number of the capture group. Numbered references that are too large result in this value being `0`.

    $1          # number `1`

    $5432       # number `5432`

    $4294967296 # number `0`

### Public Class Methods

new (source, node_id, location, flags, number)
Source

    # File lib/prism/node.rb, line 14739
    def initialize(source, node_id, location, flags, number)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @number = number
    end

Initialize a new `NumberedReferenceReadNode` node.

type ()
Source

    # File lib/prism/node.rb, line 14806
    def self.type
      :numbered_reference_read_node
    end

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

### Public Instance Methods

=== (other)
Source

    # File lib/prism/node.rb, line 14812
    def ===(other)
      other.is_a?(NumberedReferenceReadNode) &&
        (number === other.number)
    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 14748
    def accept(visitor)
      visitor.visit_numbered_reference_read_node(self)
    end

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

child_nodes ()
Source

    # File lib/prism/node.rb, line 14753
    def child_nodes
      []
    end

def `child_nodes`: () -> Array

Also aliased as: deconstruct
comment_targets ()
Source

    # File lib/prism/node.rb, line 14769
    def comment_targets
      [] #: Array[Prism::node | Location]
    end

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

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 14764
    def compact_child_nodes
      []
    end

def `compact_child_nodes`: () -> Array

copy (node_id: self.node_id, location: self.location, flags: self.flags, number: self.number)
Source

    # File lib/prism/node.rb, line 14774
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, number: self.number)
      NumberedReferenceReadNode.new(source, node_id, location, flags, number)
    end

def copy: (?node_id: `Integer`, ?location: `Location`, ?flags: `Integer`, ?number: `Integer`) -> `NumberedReferenceReadNode`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

    # File lib/prism/node.rb, line 14782
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, number: number }
    end

def `deconstruct_keys`: (Array keys) -> { node_id: `Integer`, location: `Location`, number: `Integer` }

each_child_node ()
Source

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

    end

def `each_child_node`: () { (Prism::node) -> void } -> void | () -> Enumerator

inspect ()
Source

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

def inspect -> `String`

type ()
Source

    # File lib/prism/node.rb, line 14801
    def type
      :numbered_reference_read_node
    end

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