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

# class Prism::HashPatternNode

Represents a hash pattern in pattern matching.

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

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

### Attributes

constant[R]

attr_reader constant: `ConstantReadNode` | `ConstantPathNode` | nil

elements[R]

attr_reader elements: Array

rest[R]

attr_reader rest: `AssocSplatNode` | `NoKeywordsParameterNode` | nil

### Public Class Methods

new(source, node_id, location, flags, constant, elements, rest, opening_loc, closing_loc) click to toggle source

Initialize a new `HashPatternNode` node.

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

type() click to toggle source

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

    # File prism/node.rb, line 8418
    def self.type
      :hash_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 8424
    def ===(other)
      other.is_a?(HashPatternNode) &&
        (constant === other.constant) &&
        (elements.length == other.elements.length) &&
        elements.zip(other.elements).all? { |left, right| left === right } &&
        (rest === other.rest) &&
        (opening_loc.nil? == other.opening_loc.nil?) &&
        (closing_loc.nil? == other.closing_loc.nil?)
    end

accept(visitor) click to toggle source

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

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

child_nodes() click to toggle source

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

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

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

def closing: () -> String?

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

closing_loc() click to toggle source

attr_reader `closing_loc`: `Location`?

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

comment_targets() click to toggle source

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

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

compact_child_nodes() click to toggle source

def `compact_child_nodes`: () -> Array

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

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

def copy: (?node_id: Integer, ?location: `Location`, ?flags: Integer, ?constant: `ConstantReadNode` | `ConstantPathNode` | nil, ?elements: Array, ?rest: `AssocSplatNode` | `NoKeywordsParameterNode` | nil, ?opening_loc: `Location`?, ?closing_loc: `Location`?) -> `HashPatternNode`

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

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`, constant: `ConstantReadNode` | `ConstantPathNode` | nil, elements: Array, rest: `AssocSplatNode` | `NoKeywordsParameterNode` | nil, `opening_loc`: `Location`?, `closing_loc`: `Location`? }

    # File prism/node.rb, line 8346
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, constant: constant, elements: elements, rest: rest, opening_loc: opening_loc, closing_loc: closing_loc }
    end

inspect() click to toggle source

def inspect -> String

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

opening() click to toggle source

def opening: () -> String?

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

opening_loc() click to toggle source

attr_reader `opening_loc`: `Location`?

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

save_closing_loc(repository) click to toggle source

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

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

save_opening_loc(repository) click to toggle source

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

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

type() click to toggle source

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

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