class Prism::InstanceVariableWriteNode

Represents writing to an instance variable.

@foo = 1
^^^^^^^^

Attributes

The name of the instance variable, which is a ‘@` followed by an [identifier](github.com/ruby/prism/blob/main/docs/parsing_rules.md#identifiers).

@x = :y       # name `:@x`

@_foo = "bar" # name `@_foo`

The value to write to the instance variable. It can be any [non-void expression](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression).

@foo = :bar
       ^^^^

@_x = 1234
      ^^^^

Public Class Methods

Source
# File lib/prism/node.rb, line 9144
def initialize(source, node_id, location, flags, name, name_loc, value, operator_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @name = name
  @name_loc = name_loc
  @value = value
  @operator_loc = operator_loc
end

Initialize a new InstanceVariableWriteNode node.

Source
# File lib/prism/node.rb, line 9240
def self.type
  :instance_variable_write_node
end

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

Public Instance Methods

Source
# File lib/prism/node.rb, line 9246
def ===(other)
  other.is_a?(InstanceVariableWriteNode) &&
    (name === other.name) &&
    (name_loc.nil? == other.name_loc.nil?) &&
    (value === other.value) &&
    (operator_loc.nil? == other.operator_loc.nil?)
end

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

Source
# File lib/prism/node.rb, line 9156
def accept(visitor)
  visitor.visit_instance_variable_write_node(self)
end

def accept: (Visitor visitor) -> void

Source
# File lib/prism/node.rb, line 9161
def child_nodes
  [value]
end

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

Also aliased as: deconstruct
Source
# File lib/prism/node.rb, line 9171
def comment_targets
  [name_loc, value, operator_loc] #: Array[Prism::node | Location]
end

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

Source
# File lib/prism/node.rb, line 9166
def compact_child_nodes
  [value]
end

def compact_child_nodes: () -> Array

Source
# File lib/prism/node.rb, line 9176
def copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name, name_loc: self.name_loc, value: self.value, operator_loc: self.operator_loc)
  InstanceVariableWriteNode.new(source, node_id, location, flags, name, name_loc, value, operator_loc)
end

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?name: Symbol, ?name_loc: Location, ?value: Prism::node, ?operator_loc: Location) -> InstanceVariableWriteNode

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

Alias for: child_nodes
Source
# File lib/prism/node.rb, line 9184
def deconstruct_keys(keys)
  { node_id: node_id, location: location, name: name, name_loc: name_loc, value: value, operator_loc: operator_loc }
end

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, name: Symbol, name_loc: Location, value: Prism::node, operator_loc: Location }

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

def inspect -> String

Source
# File lib/prism/node.rb, line 9199
def name_loc
  location = @name_loc
  return location if location.is_a?(Location)
  @name_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

The location of the variable name.

@_x = 1
^^^
Source
# File lib/prism/node.rb, line 9225
def operator
  operator_loc.slice
end

def operator: () -> String

Source
# File lib/prism/node.rb, line 9218
def operator_loc
  location = @operator_loc
  return location if location.is_a?(Location)
  @operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

The location of the ‘=` operator.

@x = y
   ^
Source
# File lib/prism/node.rb, line 9235
def type
  :instance_variable_write_node
end

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