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

# class Prism::PinnedVariableNode

Represents the use of the ‘^` operator for pinning a variable in a pattern matching expression.

    foo in ^bar
           ^^^^

### Attributes

variable[R]

attr_reader variable: `LocalVariableReadNode` | `InstanceVariableReadNode` | `ClassVariableReadNode` | `GlobalVariableReadNode` | `BackReferenceReadNode` | `NumberedReferenceReadNode` | `ItLocalVariableReadNode` | `MissingNode`

### Public Class Methods

new(source, node_id, location, flags, variable, operator_loc) click to toggle source

Initialize a new `PinnedVariableNode` node.

    # File prism/node.rb, line 14512
    def initialize(source, node_id, location, flags, variable, operator_loc)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @variable = variable
      @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 14586
    def self.type
      :pinned_variable_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 14592
    def ===(other)
      other.is_a?(PinnedVariableNode) &&
        (variable === other.variable) &&
        (operator_loc.nil? == other.operator_loc.nil?)
    end

accept(visitor) click to toggle source

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

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

child_nodes() click to toggle source

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

    # File prism/node.rb, line 14527
    def child_nodes
      [variable]
    end

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

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

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

compact_child_nodes() click to toggle source

def `compact_child_nodes`: () -> Array

    # File prism/node.rb, line 14532
    def compact_child_nodes
      [variable]
    end

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

def copy: (?node_id: Integer, ?location: `Location`, ?flags: Integer, ?variable: `LocalVariableReadNode` | `InstanceVariableReadNode` | `ClassVariableReadNode` | `GlobalVariableReadNode` | `BackReferenceReadNode` | `NumberedReferenceReadNode` | `ItLocalVariableReadNode` | `MissingNode`, ?operator_loc: `Location`) -> `PinnedVariableNode`

    # File prism/node.rb, line 14542
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, variable: self.variable, operator_loc: self.operator_loc)
      PinnedVariableNode.new(source, node_id, location, flags, variable, 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`, variable: `LocalVariableReadNode` | `InstanceVariableReadNode` | `ClassVariableReadNode` | `GlobalVariableReadNode` | `BackReferenceReadNode` | `NumberedReferenceReadNode` | `ItLocalVariableReadNode` | `MissingNode`, `operator_loc`: `Location` }

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

inspect() click to toggle source

def inspect -> String

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

operator() click to toggle source

def operator: () -> String

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

operator_loc() click to toggle source

attr_reader `operator_loc`: `Location`

    # File prism/node.rb, line 14558
    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 14566
    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 14581
    def type
      :pinned_variable_node
    end