class Prism::CapturePatternNode - prism: Ruby Standard Library Documentation

# 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) click to toggle source

Initialize a new `CapturePatternNode` node.

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

type() click to toggle source

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

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

### Public Instance Methods

===(other) click to toggle source

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.

    # File prism/node.rb, line 3510
    def ===(other)
      other.is_a?(CapturePatternNode) &&
        (value === other.value) &&
        (target === other.target) &&
        (operator_loc.nil? == other.operator_loc.nil?)
    end

accept(visitor) click to toggle source

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

    # File prism/node.rb, line 3428
    def accept(visitor)
      visitor.visit_capture_pattern_node(self)
    end

child_nodes() click to toggle source

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

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

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

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

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

compact_child_nodes() click to toggle source

def `compact_child_nodes`: () -> Array

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

copy(node_id: self.node_id, location: self.location, flags: self.flags, value: self.value, target: self.target, operator_loc: self.operator_loc) click to toggle source

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

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

deconstruct()

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

Alias for: child_nodes
deconstruct_keys(keys) click to toggle source

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

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

inspect() click to toggle source

def inspect -> String

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

operator() click to toggle source

def operator: () -> String

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

operator_loc() click to toggle source

Represents the location of the ‘=>` operator.

    foo => bar
        ^^

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

save_operator_loc(repository) click to toggle source

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

    # File prism/node.rb, line 3484
    def save_operator_loc(repository)
      repository.enter(node_id, :operator_loc)
    end

type() click to toggle source

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

    # File prism/node.rb, line 3499
    def type
      :capture_pattern_node
    end