class Prism::LocalVariableTargetNode

Represents writing to a local variable in a context that doesn’t have an explicit value.

foo, bar = baz
^^^  ^^^

Attributes

depth[R]

attr_reader depth: Integer

name[R]

attr_reader name: Symbol

Public Class Methods

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

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

# File lib/prism/node.rb, line 12393
def initialize(source, name, depth, location)
  @source = source
  @newline = false
  @location = location
  @name = name
  @depth = depth
end

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 lib/prism/node.rb, line 12469
def self.type
  :local_variable_target_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 lib/prism/node.rb, line 12475
def ===(other)
  other.is_a?(LocalVariableTargetNode) &&
    (name === other.name) &&
    (depth === other.depth)
end

accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

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

child_nodes() click to toggle source

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

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

Also aliased as: deconstruct

comment_targets() click to toggle source

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

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

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

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

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

def copy: (?name: Symbol, ?depth: Integer, ?location: Location) -> LocalVariableTargetNode

# File lib/prism/node.rb, line 12422
def copy(name: self.name, depth: self.depth, location: self.location)
  LocalVariableTargetNode.new(source, name, depth, location)
end

deconstruct()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

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

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

inspect() click to toggle source

def inspect -> String

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

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 lib/prism/node.rb, line 12459
def type
  :local_variable_target_node
end