class Prism::CapturePatternNode - Documentation for Ruby 3.4
Description: class Prism::CapturePatternNode: Represents assigning to a local variable in pattern matching.
Keywords: ruby,class,Prism::CapturePatternNode

# class Prism::CapturePatternNode

Represents assigning to a local variable in pattern matching.

    foo => [bar => baz]
           ^^^^^^^^^^^^

### Attributes

target [R]

Represents the target of the capture.

    foo => bar
    ^^^

value [R]

Represents the value to capture.

    foo => bar
           ^^^

### Public Class Methods

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

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

Initialize a new `CapturePatternNode` node.

type ()
Source

    # File lib/prism/node.rb, line 3516
    def self.type
      :capture_pattern_node
    end

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

### Public Instance Methods

=== (other)
Source

    # File lib/prism/node.rb, line 3522
    def ===(other)
      other.is_a?(CapturePatternNode) &&
        (value === other.value) &&
        (target === other.target) &&
        (operator_loc.nil? == other.operator_loc.nil?)
    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 3440
    def accept(visitor)
      visitor.visit_capture_pattern_node(self)
    end

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

child_nodes ()
Source

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

def `child_nodes`: () -> Array

Also aliased as: deconstruct
comment_targets ()
Source

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

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

compact_child_nodes ()
Source

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

def `compact_child_nodes`: () -> Array

copy (node_id: self.node_id, location: self.location, flags: self.flags, value: self.value, target: self.target, operator_loc: self.operator_loc)
Source

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

def copy: (?node_id: `Integer`, ?location: `Location`, ?flags: `Integer`, ?value: Prism::node, ?target: `LocalVariableTargetNode`, ?operator_loc: `Location`) -> `CapturePatternNode`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

    # File lib/prism/node.rb, line 3468
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, value: value, target: target, operator_loc: operator_loc }
    end

def `deconstruct_keys`: (Array keys) -> { node_id: `Integer`, location: `Location`, value: Prism::node, target: `LocalVariableTargetNode`, `operator_loc`: `Location` }

inspect ()
Source

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

def inspect -> `String`

operator ()
Source

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

def operator: () -> `String`

operator_loc ()
Source

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

Represents the location of the `=>` operator.

    foo => bar
        ^^

save_operator_loc (repository)
Source

    # File lib/prism/node.rb, line 3496
    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 3511
    def type
      :capture_pattern_node
    end

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