Represents writing to an instance variable.
@foo = 1 ^^^^^^^^
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
^^^^
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 10378
def initialize(source, name, name_loc, value, operator_loc, location)
@source = source
@location = location
@name = name
@name_loc = name_loc
@value = value
@operator_loc = operator_loc
end
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 10490
def self.type
:instance_variable_write_node
end
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 tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 10496
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.
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 10388
def accept(visitor)
visitor.visit_instance_variable_write_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 10393
def child_nodes
[value]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 10403
def comment_targets
[name_loc, value, operator_loc] #: Array[Prism::node | Location]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 10398
def compact_child_nodes
[value]
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 10408
def copy(name: self.name, name_loc: self.name_loc, value: self.value, operator_loc: self.operator_loc, location: self.location)
InstanceVariableWriteNode.new(source, name, name_loc, value, operator_loc, location)
end
def copy: (?name: Symbol, ?name_loc: Location, ?value: Prism::node, ?operator_loc: Location, ?location: Location) -> InstanceVariableWriteNode
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 10416
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, value: value, operator_loc: operator_loc, location: location }
end
def deconstruct_keys: (Array keys) -> { name: Symbol, name_loc: Location, value: Prism::node, operator_loc: Location, location: Location }
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 10462
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 10431
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 ^^^
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 10457
def operator
operator_loc.slice
end
def operator: () -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 10450
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 ^
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 10480
def type
:instance_variable_write_node
end
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