class Prism::ConstantPathWriteNode - Documentation for Ruby 4.1
Description: class Prism::ConstantPathWriteNode: Represents writing to a constant path.
Keywords: ruby,class,Prism::ConstantPathWriteNode

🔍

No recent searches

# class Prism::ConstantPathWriteNode

Represents writing to a constant path.

    ::Foo = 1
    ^^^^^^^^^

    Foo::Bar = 1
    ^^^^^^^^^^^^

    ::Foo::Bar = 1
    ^^^^^^^^^^^^^^

### Public Class Methods

new (source, node_id, location, flags, target, operator_loc, value)
Source

    # File lib/prism/node.rb, line 9215
    def initialize(source, node_id, location, flags, target, operator_loc, value)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @target = target
      @operator_loc = operator_loc
      @value = value
    end

Initialize a new `ConstantPathWriteNode` node.

### Public Instance Methods

target → ConstantPathNode
Source

    # File lib/prism/node.rb, line 9325
    def target
      @target
    end

A node representing the constant path being written to.

    Foo::Bar = 1
    ^^^^^^^^

    ::Foo = :abc
    ^^^^^

value → Node
Source

    # File lib/prism/node.rb, line 9363
    def value
      @value
    end

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

    FOO::BAR = :abc
               ^^^^

## Locations

### Public Instance Methods

operator_loc → Location
Source

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

    ::ABC = 123
          ^

## Node Interface

These methods are present on all subclasses of `Node`. Read the node interface docs for more information.

### Public Class Methods

type ()
Source

    # File lib/prism/node.rb, line 9302
    def self.type
      :constant_path_write_node
    end

See `Node.type`.

### Public Instance Methods

accept (visitor)
Source

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

See `Node.accept`.

child_nodes ()
Source

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

See `Node.child_nodes`.

Also aliased as: deconstruct
comment_targets ()
Source

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

See `Node.comment_targets`.

compact_child_nodes ()
Source

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

See `Node.compact_child_nodes`.

copy(**fields) → ConstantPathWriteNode
Source

    # File lib/prism/node.rb, line 9281
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, target: self.target, operator_loc: self.operator_loc, value: self.value)
      ConstantPathWriteNode.new(source, node_id, location, flags, target, operator_loc, value)
    end

Creates a copy of self with the given fields, using self as the template.

deconstruct ()
Alias for: child_nodes
each_child_node () { |target| ... }
Source

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

      yield target
      yield value
    end

See `Node.each_child_node`.

type ()
Source

    # File lib/prism/node.rb, line 9295
    def type
      :constant_path_write_node
    end

See `Node#type`.

## Repository

Methods related to `Relocation`.

### Public Instance Methods

save_operator_loc (repository)
Source

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

## Slicing

### Public Instance Methods

operator → String
Source

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

Slice the location of `operator_loc` from the source.