class Prism::LocalVariableWriteNode - Documentation for Ruby 3.3

# class Prism::LocalVariableWriteNode

Represents writing to a local variable.

    foo = 1
    ^^^^^^^

### Attributes

depth[R]

attr_reader depth: `Integer`

name[R]

attr_reader name: `Symbol`

name_loc[R]

attr_reader `name_loc`: `Location`

operator_loc[R]

attr_reader `operator_loc`: `Location`

value[R]

attr_reader value: `Node`

### Public Class Methods

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

def initialize: (name: `Symbol`, depth: `Integer`, `name_loc`: `Location`, value: `Node`, `operator_loc`: `Location`, location: `Location`) -> void

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

type() click to toggle source

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 lib/prism/node.rb, line 11401
    def self.type
      :local_variable_write_node
    end

### Public Instance Methods

accept(visitor) click to toggle source

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

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

child_nodes() click to toggle source

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

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

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

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

    # File lib/prism/node.rb, line 11336
    def comment_targets
      [name_loc, value, operator_loc]
    end

compact_child_nodes() click to toggle source

def `compact_child_nodes`: () -> Array

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

copy(**params) click to toggle source

def copy: (**params) -> `LocalVariableWriteNode`

    # File lib/prism/node.rb, line 11341
    def copy(**params)
      LocalVariableWriteNode.new(
        params.fetch(:name) { name },
        params.fetch(:depth) { depth },
        params.fetch(:name_loc) { name_loc },
        params.fetch(:value) { value },
        params.fetch(:operator_loc) { operator_loc },
        params.fetch(:location) { location },
      )
    end

deconstruct()

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

Alias for: child_nodes
deconstruct_keys(keys) click to toggle source

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

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

inspect(inspector = NodeInspector.new) click to toggle source

def inspect(inspector: NodeInspector) -> `String`

    # File lib/prism/node.rb, line 11366
    def inspect(inspector = NodeInspector.new)
      inspector << inspector.header(self)
      inspector << "├── name: #{name.inspect}\n"
      inspector << "├── depth: #{depth.inspect}\n"
      inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
      inspector << "├── value:\n"
      inspector << inspector.child_node(value, "│   ")
      inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
      inspector.to_str
    end

operator() click to toggle source

def operator: () -> `String`

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

type() click to toggle source

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`

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