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

# class Prism::InstanceVariableWriteNode

Represents writing to an instance variable.

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

### Attributes

name[R]

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`

value[R]

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

new(source, node_id, location, flags, name, name_loc, value, operator_loc) click to toggle source

Initialize a new `InstanceVariableWriteNode` node.

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

type() click to toggle source

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

    # File prism/node.rb, line 10367
    def self.type
      :instance_variable_write_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 10373
    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

accept(visitor) click to toggle source

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

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

child_nodes() click to toggle source

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

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

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

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

    # File prism/node.rb, line 10286
    def comment_targets
      [name_loc, value, operator_loc] #: Array[Prism::node | Location]
    end

compact_child_nodes() click to toggle source

def `compact_child_nodes`: () -> Array

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

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

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

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

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, `name_loc`: `Location`, value: Prism::node, `operator_loc`: `Location` }

    # File prism/node.rb, line 10299
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, name: name, name_loc: name_loc, value: value, operator_loc: operator_loc }
    end

inspect() click to toggle source

def inspect -> String

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

name_loc() click to toggle source

The location of the variable name.

    @_x = 1
    ^^^

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

operator() click to toggle source

def operator: () -> String

    # File prism/node.rb, line 10352
    def operator
      operator_loc.slice
    end

operator_loc() click to toggle source

The location of the ‘=` operator.

    @x = y
       ^

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

save_name_loc(repository) click to toggle source

Save the `name_loc` location using the given saved source so that it can be retrieved later.

    # File prism/node.rb, line 10322
    def save_name_loc(repository)
      repository.enter(node_id, :name_loc)
    end

save_operator_loc(repository) click to toggle source

Save the `operator_loc` location using the given saved source so that it can be retrieved later.

    # File prism/node.rb, line 10347
    def save_operator_loc(repository)
      repository.enter(node_id, :operator_loc)
    end

type() click to toggle source

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

    # File prism/node.rb, line 10362
    def type
      :instance_variable_write_node
    end