Class: Prism::InstanceVariableReadNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents referencing an instance variable.

@foo
^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, location) ⇒ InstanceVariableReadNode

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



9328
9329
9330
9331
 
# File 'lib/prism/node.rb', line 9328

def initialize(name, location)
  @name = name
  @location = location
end

Instance Attribute Details

#name ⇒ Object (readonly)

attr_reader name: Symbol



9325
9326
9327
 
# File 'lib/prism/node.rb', line 9325

def name
  @name
end

Class Method Details

.type ⇒ Object

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



9400
9401
9402
 
# File 'lib/prism/node.rb', line 9400

def self.type
  :instance_variable_read_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



9334
9335
9336
 
# File 'lib/prism/node.rb', line 9334

def accept(visitor)
  visitor.visit_instance_variable_read_node(self)
end

#child_nodes ⇒ Object Also known as: deconstruct

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



9339
9340
9341
 
# File 'lib/prism/node.rb', line 9339

def child_nodes
  []
end

#comment_targets ⇒ Object

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



9349
9350
9351
 
# File 'lib/prism/node.rb', line 9349

def comment_targets
  []
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



9344
9345
9346
 
# File 'lib/prism/node.rb', line 9344

def compact_child_nodes
  []
end

#copy(**params) ⇒ Object

def copy: (**params) -> InstanceVariableReadNode



9354
9355
9356
9357
9358
9359
 
# File 'lib/prism/node.rb', line 9354

def copy(**params)
  InstanceVariableReadNode.new(
    params.fetch(:name) { name },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



9365
9366
9367
 
# File 'lib/prism/node.rb', line 9365

def deconstruct_keys(keys)
  { name: name, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



9370
9371
9372
9373
9374
 
# File 'lib/prism/node.rb', line 9370

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "└── name: #{name.inspect}\n"
  inspector.to_str
end

#type ⇒ Object

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



9390
9391
9392
 
# File 'lib/prism/node.rb', line 9390

def type
  :instance_variable_read_node
end