class Prism::LocalVariableReadNode - Documentation for Ruby 3.4
Description: class Prism::LocalVariableReadNode: Represents reading a local variable. Note that this requires that a local variable of the same name has already been written to in the same scope, oth
Keywords: ruby,class,Prism::LocalVariableReadNode

# class Prism::LocalVariableReadNode

Represents reading a local variable. Note that this requires that a local variable of the same name has already been written to in the same scope, otherwise it is parsed as a method call.

    foo
    ^^^

### Attributes

depth [R]

The number of visible scopes that should be searched to find the origin of this local variable.

    foo = 1; foo # depth 0

    bar = 2; tap { bar } # depth 1

The specific rules for calculating the depth may differ from individual Ruby implementations, as they are not specified by the language. For more information, see the Prism documentation.

name [R]

The name of the local variable, which is an identifier.

    x      # name `:x`

    _Test  # name `:_Test`

Note that this can also be an underscore followed by a number for the default block parameters.

    _1     # name `:_1`

### Public Class Methods

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

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

Initialize a new `LocalVariableReadNode` node.

type ()
Source

    # File lib/prism/node.rb, line 12212
    def self.type
      :local_variable_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 12218
    def ===(other)
      other.is_a?(LocalVariableReadNode) &&
        (name === other.name) &&
        (depth === other.depth)
    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 12149
    def accept(visitor)
      visitor.visit_local_variable_read_node(self)
    end

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

child_nodes ()
Source

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

def `child_nodes`: () -> Array

Also aliased as: deconstruct
comment_targets ()
Source

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

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

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 12159
    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, depth: self.depth)
Source

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

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

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

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

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

inspect ()
Source

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

def inspect -> `String`

type ()
Source

    # File lib/prism/node.rb, line 12207
    def type
      :local_variable_read_node
    end

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