class Prism::LocalVariableReadNode - prism: Ruby Standard Library Documentation

# 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](github.com/ruby/prism/blob/main/docs/local_variable_depth.md).

name[R]

The name of the local variable, which is an [identifier](github.com/ruby/prism/blob/main/docs/parsing_rules.md#identifiers).

    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) click to toggle source

Initialize a new `LocalVariableReadNode` node.

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

type() click to toggle source

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

    # File prism/node.rb, line 12110
    def self.type
      :local_variable_read_node
    end

### Public Instance Methods

===(other) click to toggle source

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.

    # File prism/node.rb, line 12116
    def ===(other)
      other.is_a?(LocalVariableReadNode) &&
        (name === other.name) &&
        (depth === other.depth)
    end

accept(visitor) click to toggle source

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

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

child_nodes() click to toggle source

def `child_nodes`: () -> Array[nil | Node]

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

Also aliased as: deconstruct
comment_targets() click to toggle source

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

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

compact_child_nodes() click to toggle source

def `compact_child_nodes`: () -> Array

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

copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name, depth: self.depth) click to toggle source

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

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

deconstruct()

def deconstruct: () -> Array[nil | Node]

Alias for: child_nodes
deconstruct_keys(keys) click to toggle source

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

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

inspect() click to toggle source

def inspect -> String

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

type() click to toggle source

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

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