class Prism::HashPatternNode - Documentation for Ruby 4.1
Description: class Prism::HashPatternNode: Represents a hash pattern in pattern matching.
Keywords: ruby,class,Prism::HashPatternNode

🔍

No recent searches

# class Prism::HashPatternNode

Represents a hash pattern in pattern matching.

    foo => { a: 1, b: 2 }
           ^^^^^^^^^^^^^^

    foo => { a: 1, b: 2, **c }
           ^^^^^^^^^^^^^^^^^^^

    foo => Bar[a: 1, b: 2]
           ^^^^^^^^^^^^^^^

    foo in { a: 1, b: 2 }
           ^^^^^^^^^^^^^^

### Public Class Methods

new (source, node_id, location, flags, constant, elements, rest, opening_loc, closing_loc)
Source

    # File lib/prism/node.rb, line 14181
    def initialize(source, node_id, location, flags, constant, elements, rest, opening_loc, closing_loc)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @constant = constant
      @elements = elements
      @rest = rest
      @opening_loc = opening_loc
      @closing_loc = closing_loc
    end

Initialize a new `HashPatternNode` node.

### Public Instance Methods

constant → ConstantPathNode | ConstantReadNode | nil
Source

    # File lib/prism/node.rb, line 14298
    def constant
      @constant
    end

Represents the optional constant preceding the `Hash`.

    foo => Bar[a: 1, b: 2]
         ^^^

    foo => Bar::Baz[a: 1, b: 2]
         ^^^^^^^^

elements → Array[AssocNode]
Source

    # File lib/prism/node.rb, line 14311
    def elements
      @elements
    end

Represents the explicit named hash keys and values.

    foo => { a: 1, b:, ** }
             ^^^^^^^^

rest → AssocSplatNode | NoKeywordsParameterNode | nil
Source

    # File lib/prism/node.rb, line 14330
    def rest
      @rest
    end

Represents the rest of the `Hash` keys and values. This can be named, unnamed, or explicitly forbidden via `**nil`, this last one results in a `NoKeywordsParameterNode`.

    foo => { a: 1, b:, **c }
                       ^^^

    foo => { a: 1, b:, ** }
                       ^^

    foo => { a: 1, b:, **nil }
                       ^^^^^

## Locations

### Public Instance Methods

closing_loc → Location | nil
Source

    # File lib/prism/node.rb, line 14380
    def closing_loc
      location = @closing_loc
      case location
      when nil
        nil
      when Location
        location
      else
        @closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
      end
    end

The `Location` of the closing brace.

    foo => { a: 1 }
                  ^

    foo => Bar[a: 1]
                   ^

opening_loc → Location | nil
Source

    # File lib/prism/node.rb, line 14347
    def opening_loc
      location = @opening_loc
      case location
      when nil
        nil
      when Location
        location
      else
        @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
      end
    end

The `Location` of the opening brace.

    foo => { a: 1 }
           ^

    foo => Bar[a: 1]
              ^

## 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 14275
    def self.type
      :hash_pattern_node
    end

See `Node.type`.

### Public Instance Methods

accept (visitor)
Source

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

See `Node.accept`.

child_nodes ()
Source

    # File lib/prism/node.rb, line 14214
    def child_nodes
      [constant, *elements, rest]
    end

See `Node.child_nodes`.

Also aliased as: deconstruct
comment_targets ()
Source

    # File lib/prism/node.rb, line 14244
    def comment_targets
      [*constant, *elements, *rest, *opening_loc, *closing_loc] #: Array[Prism::node | Location]
    end

See `Node.comment_targets`.

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 14233
    def compact_child_nodes
      compact = [] #: Array[Prism::node]
      if (constant = self.constant); compact << constant; end
      compact.concat(elements)
      if (rest = self.rest); compact << rest; end
      compact
    end

See `Node.compact_child_nodes`.

copy(**fields) → HashPatternNode
Source

    # File lib/prism/node.rb, line 14254
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, constant: self.constant, elements: self.elements, rest: self.rest, opening_loc: self.opening_loc, closing_loc: self.closing_loc)
      HashPatternNode.new(source, node_id, location, flags, constant, elements, rest, opening_loc, closing_loc)
    end

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

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

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

      if (constant = self.constant); yield constant; end
      elements.each { |node| yield node }
      if (rest = self.rest); yield rest; end
    end

See `Node.each_child_node`.

type ()
Source

    # File lib/prism/node.rb, line 14268
    def type
      :hash_pattern_node
    end

See `Node#type`.

## Repository

Methods related to `Relocation`.

### Public Instance Methods

save_closing_loc (repository)
Source

    # File lib/prism/node.rb, line 14397
    def save_closing_loc(repository)
      repository.enter(node_id, :closing_loc) unless @closing_loc.nil?
    end

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

save_opening_loc (repository)
Source

    # File lib/prism/node.rb, line 14364
    def save_opening_loc(repository)
      repository.enter(node_id, :opening_loc) unless @opening_loc.nil?
    end

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

## Slicing

### Public Instance Methods

closing → String | nil
Source

    # File lib/prism/node.rb, line 14418
    def closing
      closing_loc&.slice
    end

Slice the location of `closing_loc` from the source.

opening → String | nil
Source

    # File lib/prism/node.rb, line 14408
    def opening
      opening_loc&.slice
    end

Slice the location of `opening_loc` from the source.