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.




attr_reader depth: Integer


attr_reader name: Symbol

Public Class Methods

new(name, depth, location) click to toggle source

def initialize: (name: Symbol, depth: Integer, location: Location) -> void

# File prism/node.rb, line 11118
def initialize(name, depth, location)
  @name = name
  @depth = depth
  @location = location
type() click to toggle source

Similar to type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.

def self.type: () -> Symbol

# File prism/node.rb, line 11193
def self.type

Public Instance Methods

accept(visitor) click to toggle source

def accept: (visitor: Visitor) -> void

# File prism/node.rb, line 11125
def accept(visitor)
child_nodes() click to toggle source

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

# File prism/node.rb, line 11130
def child_nodes
Also aliased as: deconstruct
comment_targets() click to toggle source

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

# File prism/node.rb, line 11140
def comment_targets
compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File prism/node.rb, line 11135
def compact_child_nodes
copy(**params) click to toggle source

def copy: (**params) -> LocalVariableReadNode

# File prism/node.rb, line 11145
def copy(**params)
    params.fetch(:name) { name },
    params.fetch(:depth) { depth },
    params.fetch(:location) { location },

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

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

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]

# File prism/node.rb, line 11157
def deconstruct_keys(keys)
  { name: name, depth: depth, location: location }
inspect(inspector = click to toggle source

def inspect(inspector: NodeInspector) -> String

# File prism/node.rb, line 11162
def inspect(inspector =
  inspector << inspector.header(self)
  inspector << "├── name: #{name.inspect}\n"
  inspector << "└── depth: #{depth.inspect}\n"
type() click to toggle source

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.

Instead, you can call type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.

def type: () -> Symbol

# File prism/node.rb, line 11183
def type