class Prism::LocalVariableWriteNode - Documentation for Ruby 4.0
Description: class Prism::LocalVariableWriteNode: Represents writing to a local variable.
Keywords: ruby,class,Prism::LocalVariableWriteNode

🔍

No recent searches

# class Prism::LocalVariableWriteNode

Represents writing to a local variable.

    foo = 1
    ^^^^^^^

### Attributes

depth [R]

The number of semantic scopes we have to traverse to find the declaration of this variable.

    foo = 1         # depth 0

    tap { foo = 1 } # depth 1

The specific rules for calculating the depth may differ from individual Ruby implementations, as they are not specified by the language. For more information, see the Prism documentation.

name [R]

The name of the local variable, which is an identifier.

    foo = :bar # name `:foo`

    abc = 123  # name `:abc`

value [R]

The value to write to the local variable. It can be any non-void expression.

    foo = :bar
          ^^^^

    abc = 1234
          ^^^^

Note that since the name of a local variable is known before the value is parsed, it is valid for a local variable to appear within the value of its own write.

    foo = foo

### Public Class Methods

new (source, node_id, location, flags, name, depth, name_loc, value, operator_loc)
Source

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

Initialize a new `LocalVariableWriteNode` node.

type ()
Source

    # File lib/prism/node.rb, line 13196
    def self.type
      :local_variable_write_node
    end

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

### Public Instance Methods

=== (other)
Source

    # File lib/prism/node.rb, line 13202
    def ===(other)
      other.is_a?(LocalVariableWriteNode) &&
        (name === other.name) &&
        (depth === other.depth) &&
        (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.

accept (visitor)
Source

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

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

child_nodes ()
Source

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

def `child_nodes`: () -> Array

Also aliased as: deconstruct
comment_targets ()
Source

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

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

compact_child_nodes ()
Source

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

def `compact_child_nodes`: () -> Array

copy (node_id: self.node_id, location: self.location, flags: self.flags, name: self.name, depth: self.depth, name_loc: self.name_loc, value: self.value, operator_loc: self.operator_loc)
Source

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

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

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

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

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

each_child_node () { |value| ... }
Source

    # File lib/prism/node.rb, line 13090
    def each_child_node
      return to_enum(:each_child_node) unless block_given?

      yield value
    end

def `each_child_node`: () { (Prism::node) -> void } -> void | () -> Enumerator

inspect ()
Source

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

def inspect -> `String`

name_loc ()
Source

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

    foo = :bar
    ^^^

operator ()
Source

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

def operator: () -> `String`

operator_loc ()
Source

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

save_name_loc (repository)
Source

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

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

save_operator_loc (repository)
Source

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

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

type ()
Source

    # File lib/prism/node.rb, line 13191
    def type
      :local_variable_write_node
    end

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