class Prism::PinnedExpressionNode - Documentation for Ruby 4.0
Description: class Prism::PinnedExpressionNode: Represents the use of the `^` operator for pinning an expression in a pattern matching expression.
Keywords: ruby,class,Prism::PinnedExpressionNode

🔍

No recent searches

# class Prism::PinnedExpressionNode

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

    foo in ^(bar)
           ^^^^^^

### Attributes

expression [R]

The expression used in the pinned expression

    foo in ^(bar)
             ^^^

### Public Class Methods

new (source, node_id, location, flags, expression, operator_loc, lparen_loc, rparen_loc)
Source

    # File lib/prism/node.rb, line 15436
    def initialize(source, node_id, location, flags, expression, operator_loc, lparen_loc, rparen_loc)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @expression = expression
      @operator_loc = operator_loc
      @lparen_loc = lparen_loc
      @rparen_loc = rparen_loc
    end

Initialize a new `PinnedExpressionNode` node.

type ()
Source

    # File lib/prism/node.rb, line 15567
    def self.type
      :pinned_expression_node
    end

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

### Public Instance Methods

=== (other)
Source

    # File lib/prism/node.rb, line 15573
    def ===(other)
      other.is_a?(PinnedExpressionNode) &&
        (expression === other.expression) &&
        (operator_loc.nil? == other.operator_loc.nil?) &&
        (lparen_loc.nil? == other.lparen_loc.nil?) &&
        (rparen_loc.nil? == other.rparen_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 15448
    def accept(visitor)
      visitor.visit_pinned_expression_node(self)
    end

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

child_nodes ()
Source

    # File lib/prism/node.rb, line 15453
    def child_nodes
      [expression]
    end

def `child_nodes`: () -> Array

Also aliased as: deconstruct
comment_targets ()
Source

    # File lib/prism/node.rb, line 15470
    def comment_targets
      [expression, operator_loc, lparen_loc, rparen_loc] #: Array[Prism::node | Location]
    end

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

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 15465
    def compact_child_nodes
      [expression]
    end

def `compact_child_nodes`: () -> Array

copy (node_id: self.node_id, location: self.location, flags: self.flags, expression: self.expression, operator_loc: self.operator_loc, lparen_loc: self.lparen_loc, rparen_loc: self.rparen_loc)
Source

    # File lib/prism/node.rb, line 15475
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, expression: self.expression, operator_loc: self.operator_loc, lparen_loc: self.lparen_loc, rparen_loc: self.rparen_loc)
      PinnedExpressionNode.new(source, node_id, location, flags, expression, operator_loc, lparen_loc, rparen_loc)
    end

def copy: (?node_id: `Integer`, ?location: `Location`, ?flags: `Integer`, ?expression: Prism::node, ?operator_loc: `Location`, ?lparen_loc: `Location`, ?rparen_loc: `Location`) -> `PinnedExpressionNode`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

    # File lib/prism/node.rb, line 15483
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, expression: expression, operator_loc: operator_loc, lparen_loc: lparen_loc, rparen_loc: rparen_loc }
    end

def `deconstruct_keys`: (Array keys) -> { node_id: `Integer`, location: `Location`, expression: Prism::node, `operator_loc`: `Location`, `lparen_loc`: `Location`, `rparen_loc`: `Location` }

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

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

      yield expression
    end

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

inspect ()
Source

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

def inspect -> `String`

lparen ()
Source

    # File lib/prism/node.rb, line 15547
    def lparen
      lparen_loc.slice
    end

def lparen: () -> `String`

lparen_loc ()
Source

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

The location of the opening parenthesis.

    foo in ^(bar)
            ^

operator ()
Source

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

def operator: () -> `String`

operator_loc ()
Source

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

    foo in ^(bar)
           ^

rparen ()
Source

    # File lib/prism/node.rb, line 15552
    def rparen
      rparen_loc.slice
    end

def rparen: () -> `String`

rparen_loc ()
Source

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

The location of the closing parenthesis.

    foo in ^(bar)
                ^

save_lparen_loc (repository)
Source

    # File lib/prism/node.rb, line 15521
    def save_lparen_loc(repository)
      repository.enter(node_id, :lparen_loc)
    end

Save the `lparen_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 15505
    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.

save_rparen_loc (repository)
Source

    # File lib/prism/node.rb, line 15537
    def save_rparen_loc(repository)
      repository.enter(node_id, :rparen_loc)
    end

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

type ()
Source

    # File lib/prism/node.rb, line 15562
    def type
      :pinned_expression_node
    end

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