class Prism::MultiWriteNode - Documentation for Ruby 3.3

# class Prism::MultiWriteNode

Represents a write to a multi-target expression.

    a, b, c = 1, 2, 3
    ^^^^^^^^^^^^^^^^^

### Attributes

lefts[R]

attr_reader lefts: Array

lparen_loc[R]

attr_reader `lparen_loc`: `Location`?

operator_loc[R]

attr_reader `operator_loc`: `Location`

rest[R]

attr_reader rest: `Node`?

rights[R]

attr_reader rights: Array

rparen_loc[R]

attr_reader `rparen_loc`: `Location`?

value[R]

attr_reader value: `Node`

### Public Class Methods

new(lefts, rest, rights, lparen_loc, rparen_loc, operator_loc, value, location) click to toggle source

def initialize: (lefts: Array, rest: `Node`?, rights: Array, `lparen_loc`: `Location`?, `rparen_loc`: `Location`?, `operator_loc`: `Location`, value: `Node`, location: `Location`) -> void

    # File lib/prism/node.rb, line 12262
    def initialize(lefts, rest, rights, lparen_loc, rparen_loc, operator_loc, value, location)
      @lefts = lefts
      @rest = rest
      @rights = rights
      @lparen_loc = lparen_loc
      @rparen_loc = rparen_loc
      @operator_loc = operator_loc
      @value = value
      @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 12378
    def self.type
      :multi_write_node
    end

### Public Instance Methods

accept(visitor) click to toggle source

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

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

child_nodes() click to toggle source

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

    # File lib/prism/node.rb, line 12279
    def child_nodes
      [*lefts, rest, *rights, value]
    end

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

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

    # File lib/prism/node.rb, line 12294
    def comment_targets
      [*lefts, *rest, *rights, *lparen_loc, *rparen_loc, operator_loc, value]
    end

compact_child_nodes() click to toggle source

def `compact_child_nodes`: () -> Array

    # File lib/prism/node.rb, line 12284
    def compact_child_nodes
      compact = []
      compact.concat(lefts)
      compact << rest if rest
      compact.concat(rights)
      compact << value
      compact
    end

copy(**params) click to toggle source

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

    # File lib/prism/node.rb, line 12299
    def copy(**params)
      MultiWriteNode.new(
        params.fetch(:lefts) { lefts },
        params.fetch(:rest) { rest },
        params.fetch(:rights) { rights },
        params.fetch(:lparen_loc) { lparen_loc },
        params.fetch(:rparen_loc) { rparen_loc },
        params.fetch(:operator_loc) { operator_loc },
        params.fetch(:value) { value },
        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 12316
    def deconstruct_keys(keys)
      { lefts: lefts, rest: rest, rights: rights, lparen_loc: lparen_loc, rparen_loc: rparen_loc, operator_loc: operator_loc, value: value, location: location }
    end

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

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

    # File lib/prism/node.rb, line 12336
    def inspect(inspector = NodeInspector.new)
      inspector << inspector.header(self)
      inspector << "├── lefts: #{inspector.list("#{inspector.prefix}│   ", lefts)}"
      if (rest = self.rest).nil?
        inspector << "├── rest: ∅\n"
      else
        inspector << "├── rest:\n"
        inspector << rest.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
      end
      inspector << "├── rights: #{inspector.list("#{inspector.prefix}│   ", rights)}"
      inspector << "├── lparen_loc: #{inspector.location(lparen_loc)}\n"
      inspector << "├── rparen_loc: #{inspector.location(rparen_loc)}\n"
      inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
      inspector << "└── value:\n"
      inspector << inspector.child_node(value, "    ")
      inspector.to_str
    end

lparen() click to toggle source

def lparen: () -> `String`?

    # File lib/prism/node.rb, line 12321
    def lparen
      lparen_loc&.slice
    end

operator() click to toggle source

def operator: () -> `String`

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

rparen() click to toggle source

def rparen: () -> `String`?

    # File lib/prism/node.rb, line 12326
    def rparen
      rparen_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 12368
    def type
      :multi_write_node
    end