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

🔍

No recent searches

# class Prism::HashNode

Represents a hash literal.

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

### Public Class Methods

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

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

### Public Instance Methods

elements → Array[AssocNode | AssocSplatNode]
Source

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

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

    { a: b }
      ^^^^

    { **foo }
      ^^^^^

## Locations

### Public Instance Methods

closing_loc → Location
Source

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

opening_loc → Location
Source

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

## 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 14047
    def self.type
      :hash_node
    end

See `Node.type`.

### Public Instance Methods

accept (visitor)
Source

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

See `Node.accept`.

child_nodes ()
Source

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

See `Node.child_nodes`.

Also aliased as: deconstruct
comment_targets ()
Source

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

See `Node.comment_targets`.

compact_child_nodes ()
Source

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

See `Node.compact_child_nodes`.

copy(**fields) → HashNode
Source

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

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

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

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

      elements.each { |node| yield node }
    end

See `Node.each_child_node`.

type ()
Source

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

See `Node#type`.

## Repository

Methods related to `Relocation`.

### Public Instance Methods

save_closing_loc (repository)
Source

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

## Slicing

### Public Instance Methods

closing → String
Source

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

Slice the location of `closing_loc` from the source.

opening → String
Source

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

Slice the location of `opening_loc` from the source.