class Prism::LocalVariableReadNode - Documentation for Ruby 4.1
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

🔍

No recent searches

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

### Public Class Methods

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

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

### Public Instance Methods

depth → Integer
Source

    # File lib/prism/node.rb, line 20712
    def depth
      @depth
    end

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 → Symbol
Source

    # File lib/prism/node.rb, line 20696
    def name
      @name
    end

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`

## 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 20671
    def self.type
      :local_variable_read_node
    end

See `Node.type`.

### Public Instance Methods

accept (visitor)
Source

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

See `Node.accept`.

child_nodes ()
Source

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

See `Node.child_nodes`.

Also aliased as: deconstruct
comment_targets ()
Source

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

See `Node.comment_targets`.

compact_child_nodes ()
Source

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

See `Node.compact_child_nodes`.

copy(**fields) → LocalVariableReadNode
Source

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

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

deconstruct ()
Alias for: child_nodes
each_child_node (&blk)
Source

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

    end

See `Node.each_child_node`.

type ()
Source

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

See `Node#type`.

## Repository

Methods related to `Relocation`.

## Slicing