class Prism::MultiWriteNode - Documentation for Ruby 4.0
Description: class Prism::MultiWriteNode: Represents a write to a multi-target expression.
Keywords: ruby,class,Prism::MultiWriteNode

🔍

No recent searches

# class Prism::MultiWriteNode

Represents a write to a multi-target expression.

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

### Attributes

lefts [R]

Represents the targets expressions before a splat node.

    a, b, * = 1, 2, 3, 4, 5
    ^^^^

The splat node can be absent, in that case all target expressions are in the left field.

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

rest [R]

Represents a splat node in the target expression.

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

The variable can be empty, this results in a `SplatNode` with a `nil` expression field.

    a, b, * = 1, 2, 3, 4
          ^

If the `*` is omitted, this field will contain an `ImplicitRestNode`

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

rights [R]

Represents the targets expressions after a splat node.

    a, *, b, c = 1, 2, 3, 4, 5
          ^^^^

value [R]

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

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

### Public Class Methods

new (source, node_id, location, flags, lefts, rest, rights, lparen_loc, rparen_loc, operator_loc, value)
Source

    # File lib/prism/node.rb, line 14156
    def initialize(source, node_id, location, flags, lefts, rest, rights, lparen_loc, rparen_loc, operator_loc, value)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @lefts = lefts
      @rest = rest
      @rights = rights
      @lparen_loc = lparen_loc
      @rparen_loc = rparen_loc
      @operator_loc = operator_loc
      @value = value
    end

Initialize a new `MultiWriteNode` node.

type ()
Source

    # File lib/prism/node.rb, line 14343
    def self.type
      :multi_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 14349
    def ===(other)
      other.is_a?(MultiWriteNode) &&
        (lefts.length == other.lefts.length) &&
        lefts.zip(other.lefts).all? { |left, right| left === right } &&
        (rest === other.rest) &&
        (rights.length == other.rights.length) &&
        rights.zip(other.rights).all? { |left, right| left === right } &&
        (lparen_loc.nil? == other.lparen_loc.nil?) &&
        (rparen_loc.nil? == other.rparen_loc.nil?) &&
        (operator_loc.nil? == other.operator_loc.nil?) &&
        (value === other.value)
    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 14171
    def accept(visitor)
      visitor.visit_multi_write_node(self)
    end

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

child_nodes ()
Source

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

def `child_nodes`: () -> Array

Also aliased as: deconstruct
comment_targets ()
Source

    # File lib/prism/node.rb, line 14201
    def comment_targets
      [*lefts, *rest, *rights, *lparen_loc, *rparen_loc, operator_loc, value] #: Array[Prism::node | Location]
    end

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

compact_child_nodes ()
Source

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

def `compact_child_nodes`: () -> Array

copy (node_id: self.node_id, location: self.location, flags: self.flags, lefts: self.lefts, rest: self.rest, rights: self.rights, lparen_loc: self.lparen_loc, rparen_loc: self.rparen_loc, operator_loc: self.operator_loc, value: self.value)
Source

    # File lib/prism/node.rb, line 14206
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, lefts: self.lefts, rest: self.rest, rights: self.rights, lparen_loc: self.lparen_loc, rparen_loc: self.rparen_loc, operator_loc: self.operator_loc, value: self.value)
      MultiWriteNode.new(source, node_id, location, flags, lefts, rest, rights, lparen_loc, rparen_loc, operator_loc, value)
    end

def copy: (?node_id: `Integer`, ?location: `Location`, ?flags: `Integer`, ?lefts: Array[LocalVariableTargetNode | `InstanceVariableTargetNode` | `ClassVariableTargetNode` | `GlobalVariableTargetNode` | `ConstantTargetNode` | `ConstantPathTargetNode` | `CallTargetNode` | `IndexTargetNode` | `MultiTargetNode` | `BackReferenceReadNode` | NumberedReferenceReadNode], ?rest: `ImplicitRestNode` | `SplatNode` | nil, ?rights: Array[LocalVariableTargetNode | `InstanceVariableTargetNode` | `ClassVariableTargetNode` | `GlobalVariableTargetNode` | `ConstantTargetNode` | `ConstantPathTargetNode` | `CallTargetNode` | `IndexTargetNode` | `MultiTargetNode` | `BackReferenceReadNode` | NumberedReferenceReadNode], ?lparen_loc: `Location`?, ?rparen_loc: `Location`?, ?operator_loc: `Location`, ?value: Prism::node) -> `MultiWriteNode`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

    # File lib/prism/node.rb, line 14214
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, lefts: lefts, rest: rest, rights: rights, lparen_loc: lparen_loc, rparen_loc: rparen_loc, operator_loc: operator_loc, value: value }
    end

def `deconstruct_keys`: (Array keys) -> { node_id: `Integer`, location: `Location`, lefts: Array[LocalVariableTargetNode | `InstanceVariableTargetNode` | `ClassVariableTargetNode` | `GlobalVariableTargetNode` | `ConstantTargetNode` | `ConstantPathTargetNode` | `CallTargetNode` | `IndexTargetNode` | `MultiTargetNode` | `BackReferenceReadNode` | NumberedReferenceReadNode], rest: `ImplicitRestNode` | `SplatNode` | nil, rights: Array[LocalVariableTargetNode | `InstanceVariableTargetNode` | `ClassVariableTargetNode` | `GlobalVariableTargetNode` | `ConstantTargetNode` | `ConstantPathTargetNode` | `CallTargetNode` | `IndexTargetNode` | `MultiTargetNode` | `BackReferenceReadNode` | NumberedReferenceReadNode], `lparen_loc`: `Location`?, `rparen_loc`: `Location`?, `operator_loc`: `Location`, value: Prism::node }

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

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

      lefts.each { |node| yield node }
      yield rest if rest
      rights.each { |node| yield node }
      yield value
    end

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

inspect ()
Source

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

def inspect -> `String`

lparen ()
Source

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

def lparen: () -> `String`?

lparen_loc ()
Source

    # File lib/prism/node.rb, line 14255
    def lparen_loc
      location = @lparen_loc
      case location
      when nil
        nil
      when Location
        location
      else
        @lparen_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
      end
    end

The location of the opening parenthesis.

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

operator ()
Source

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

def operator: () -> `String`

operator_loc ()
Source

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

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

rparen ()
Source

    # File lib/prism/node.rb, line 14323
    def rparen
      rparen_loc&.slice
    end

def rparen: () -> `String`?

rparen_loc ()
Source

    # File lib/prism/node.rb, line 14277
    def rparen_loc
      location = @rparen_loc
      case location
      when nil
        nil
      when Location
        location
      else
        @rparen_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
      end
    end

The location of the closing parenthesis.

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

save_lparen_loc (repository)
Source

    # File lib/prism/node.rb, line 14269
    def save_lparen_loc(repository)
      repository.enter(node_id, :lparen_loc) unless @lparen_loc.nil?
    end

Save the `lparen_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 14307
    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.

save_rparen_loc (repository)
Source

    # File lib/prism/node.rb, line 14291
    def save_rparen_loc(repository)
      repository.enter(node_id, :rparen_loc) unless @rparen_loc.nil?
    end

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

type ()
Source

    # File lib/prism/node.rb, line 14338
    def type
      :multi_write_node
    end

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