class Prism::BackReferenceReadNode - Documentation for Ruby 3.4
Description: class Prism::BackReferenceReadNode: Represents reading a reference to a field in the previous match.
Keywords: ruby,class,Prism::BackReferenceReadNode

# class Prism::BackReferenceReadNode

Represents reading a reference to a field in the previous match.

    $'
    ^^

### Attributes

name [R]

The name of the back-reference variable, including the leading `$`.

    $& # name `:$&`

    $+ # name `:$+`

### Public Class Methods

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

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

Initialize a new `BackReferenceReadNode` node.

type ()
Source

    # File lib/prism/node.rb, line 1477
    def self.type
      :back_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 1483
    def ===(other)
      other.is_a?(BackReferenceReadNode) &&
        (name === other.name)
    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 1427
    def accept(visitor)
      visitor.visit_back_reference_read_node(self)
    end

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

child_nodes ()
Source

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

def `child_nodes`: () -> Array

Also aliased as: deconstruct
comment_targets ()
Source

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

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

compact_child_nodes ()
Source

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

def `compact_child_nodes`: () -> Array

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

    # File lib/prism/node.rb, line 1447
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name)
      BackReferenceReadNode.new(source, node_id, location, flags, name)
    end

def copy: (?node_id: `Integer`, ?location: `Location`, ?flags: `Integer`, ?name: `Symbol`) -> `BackReferenceReadNode`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

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

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

inspect ()
Source

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

def inspect -> `String`

type ()
Source

    # File lib/prism/node.rb, line 1472
    def type
      :back_reference_read_node
    end

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