class Prism::HashNode - Documentation for Ruby 3.4
Description: class Prism::HashNode: Represents a hash literal.
Keywords: ruby,class,Prism::HashNode

# class Prism::HashNode

Represents a hash literal.

    { a => b }
    ^^^^^^^^^^

### Attributes

elements [R]

The elements of the hash. These can be either `AssocNode`s or `AssocSplatNode`s.

    { a: b }
      ^^^^

    { **foo }
      ^^^^^

### Public Class Methods

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

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

Initialize a new `HashNode` node.

type ()
Source

    # File lib/prism/node.rb, line 8343
    def self.type
      :hash_node
    end

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

### Public Instance Methods

=== (other)
Source

    # File lib/prism/node.rb, line 8349
    def ===(other)
      other.is_a?(HashNode) &&
        (opening_loc.nil? == other.opening_loc.nil?) &&
        (elements.length == other.elements.length) &&
        elements.zip(other.elements).all? { |left, right| left === right } &&
        (closing_loc.nil? == other.closing_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 8249
    def accept(visitor)
      visitor.visit_hash_node(self)
    end

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

child_nodes ()
Source

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

def `child_nodes`: () -> Array

Also aliased as: deconstruct
closing ()
Source

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

def closing: () -> `String`

closing_loc ()
Source

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

The location of the closing brace.

    { a => b }
             ^

comment_targets ()
Source

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

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

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 8259
    def compact_child_nodes
      [*elements]
    end

def `compact_child_nodes`: () -> Array

copy (node_id: self.node_id, location: self.location, flags: self.flags, opening_loc: self.opening_loc, elements: self.elements, closing_loc: self.closing_loc)
Source

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

def copy: (?node_id: `Integer`, ?location: `Location`, ?flags: `Integer`, ?opening_loc: `Location`, ?elements: Array[AssocNode | AssocSplatNode], ?closing_loc: `Location`) -> `HashNode`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

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

def `deconstruct_keys`: (Array keys) -> { node_id: `Integer`, location: `Location`, `opening_loc`: `Location`, elements: Array[AssocNode | AssocSplatNode], `closing_loc`: `Location` }

inspect ()
Source

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

def inspect -> `String`

opening ()
Source

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

def opening: () -> `String`

opening_loc ()
Source

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

The location of the opening brace.

    { a => b }
    ^

save_closing_loc (repository)
Source

    # File lib/prism/node.rb, line 8318
    def save_closing_loc(repository)
      repository.enter(node_id, :closing_loc)
    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 8293
    def save_opening_loc(repository)
      repository.enter(node_id, :opening_loc)
    end

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

type ()
Source

    # File lib/prism/node.rb, line 8338
    def type
      :hash_node
    end

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