class Prism::IndexOrWriteNode - Documentation for Ruby 4.0
Description: class Prism::IndexOrWriteNode: Represents the use of the `||=` operator on a call to `[]`. foo.
Keywords: ruby,class,Prism::IndexOrWriteNode

🔍

No recent searches

# class Prism::IndexOrWriteNode

Represents the use of the `||=` operator on a call to `[]`.

    foo.bar[baz] ||= value
    ^^^^^^^^^^^^^^^^^^^^^^

### Attributes

arguments [R]

attr_reader arguments: `ArgumentsNode`?

block [R]

attr_reader block: `BlockArgumentNode`?

receiver [R]

attr_reader receiver: Prism::node?

value [R]

attr_reader value: Prism::node

### Public Class Methods

new (source, node_id, location, flags, receiver, call_operator_loc, opening_loc, arguments, closing_loc, block, operator_loc, value)
Source

    # File lib/prism/node.rb, line 10105
    def initialize(source, node_id, location, flags, receiver, call_operator_loc, opening_loc, arguments, closing_loc, block, operator_loc, value)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @receiver = receiver
      @call_operator_loc = call_operator_loc
      @opening_loc = opening_loc
      @arguments = arguments
      @closing_loc = closing_loc
      @block = block
      @operator_loc = operator_loc
      @value = value
    end

Initialize a new `IndexOrWriteNode` node.

type ()
Source

    # File lib/prism/node.rb, line 10289
    def self.type
      :index_or_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 10295
    def ===(other)
      other.is_a?(IndexOrWriteNode) &&
        (flags === other.flags) &&
        (receiver === other.receiver) &&
        (call_operator_loc.nil? == other.call_operator_loc.nil?) &&
        (opening_loc.nil? == other.opening_loc.nil?) &&
        (arguments === other.arguments) &&
        (closing_loc.nil? == other.closing_loc.nil?) &&
        (block === other.block) &&
        (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 10121
    def accept(visitor)
      visitor.visit_index_or_write_node(self)
    end

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

attribute_write? ()
Source

    # File lib/prism/node.rb, line 10179
    def attribute_write?
      flags.anybits?(CallNodeFlags::ATTRIBUTE_WRITE)
    end

def attribute_write?: () -> bool

call_operator ()
Source

    # File lib/prism/node.rb, line 10259
    def call_operator
      call_operator_loc&.slice
    end

def `call_operator`: () -> `String`?

call_operator_loc ()
Source

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

attr_reader `call_operator_loc`: `Location`?

child_nodes ()
Source

    # File lib/prism/node.rb, line 10126
    def child_nodes
      [receiver, arguments, block, value]
    end

def `child_nodes`: () -> Array

Also aliased as: deconstruct
closing ()
Source

    # File lib/prism/node.rb, line 10269
    def closing
      closing_loc.slice
    end

def closing: () -> `String`

closing_loc ()
Source

    # File lib/prism/node.rb, line 10227
    def closing_loc
      location = @closing_loc
      return location if location.is_a?(Location)
      @closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
    end

attr_reader `closing_loc`: `Location`

comment_targets ()
Source

    # File lib/prism/node.rb, line 10151
    def comment_targets
      [*receiver, *call_operator_loc, opening_loc, *arguments, closing_loc, *block, operator_loc, value] #: Array[Prism::node | Location]
    end

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

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 10141
    def compact_child_nodes
      compact = [] #: Array[Prism::node]
      compact << receiver if receiver
      compact << arguments if arguments
      compact << block if block
      compact << value
      compact
    end

def `compact_child_nodes`: () -> Array

copy (node_id: self.node_id, location: self.location, flags: self.flags, receiver: self.receiver, call_operator_loc: self.call_operator_loc, opening_loc: self.opening_loc, arguments: self.arguments, closing_loc: self.closing_loc, block: self.block, operator_loc: self.operator_loc, value: self.value)
Source

    # File lib/prism/node.rb, line 10156
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, receiver: self.receiver, call_operator_loc: self.call_operator_loc, opening_loc: self.opening_loc, arguments: self.arguments, closing_loc: self.closing_loc, block: self.block, operator_loc: self.operator_loc, value: self.value)
      IndexOrWriteNode.new(source, node_id, location, flags, receiver, call_operator_loc, opening_loc, arguments, closing_loc, block, operator_loc, value)
    end

def copy: (?node_id: `Integer`, ?location: `Location`, ?flags: `Integer`, ?receiver: Prism::node?, ?call_operator_loc: `Location`?, ?opening_loc: `Location`, ?arguments: `ArgumentsNode`?, ?closing_loc: `Location`, ?block: `BlockArgumentNode`?, ?operator_loc: `Location`, ?value: Prism::node) -> `IndexOrWriteNode`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

    # File lib/prism/node.rb, line 10164
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, receiver: receiver, call_operator_loc: call_operator_loc, opening_loc: opening_loc, arguments: arguments, closing_loc: closing_loc, block: block, operator_loc: operator_loc, value: value }
    end

def `deconstruct_keys`: (Array keys) -> { node_id: `Integer`, location: `Location`, receiver: Prism::node?, `call_operator_loc`: `Location`?, `opening_loc`: `Location`, arguments: `ArgumentsNode`?, `closing_loc`: `Location`, block: `BlockArgumentNode`?, `operator_loc`: `Location`, value: Prism::node }

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

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

      yield receiver if receiver
      yield arguments if arguments
      yield block if block
      yield value
    end

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

ignore_visibility? ()
Source

    # File lib/prism/node.rb, line 10184
    def ignore_visibility?
      flags.anybits?(CallNodeFlags::IGNORE_VISIBILITY)
    end

def ignore_visibility?: () -> bool

inspect ()
Source

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

def inspect -> `String`

opening ()
Source

    # File lib/prism/node.rb, line 10264
    def opening
      opening_loc.slice
    end

def opening: () -> `String`

opening_loc ()
Source

    # File lib/prism/node.rb, line 10211
    def opening_loc
      location = @opening_loc
      return location if location.is_a?(Location)
      @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
    end

attr_reader `opening_loc`: `Location`

operator ()
Source

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

def operator: () -> `String`

operator_loc ()
Source

    # File lib/prism/node.rb, line 10243
    def operator_loc
      location = @operator_loc
      return location if location.is_a?(Location)
      @operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
    end

attr_reader `operator_loc`: `Location`

save_call_operator_loc (repository)
Source

    # File lib/prism/node.rb, line 10206
    def save_call_operator_loc(repository)
      repository.enter(node_id, :call_operator_loc) unless @call_operator_loc.nil?
    end

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

save_closing_loc (repository)
Source

    # File lib/prism/node.rb, line 10235
    def save_closing_loc(repository)
      repository.enter(node_id, :closing_loc)
    end

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

save_opening_loc (repository)
Source

    # File lib/prism/node.rb, line 10219
    def save_opening_loc(repository)
      repository.enter(node_id, :opening_loc)
    end

Save the `opening_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 10251
    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 10284
    def type
      :index_or_write_node
    end

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

variable_call? ()
Source

    # File lib/prism/node.rb, line 10174
    def variable_call?
      flags.anybits?(CallNodeFlags::VARIABLE_CALL)
    end

def variable_call?: () -> bool