class Prism::AssocNode - Documentation for Ruby 4.0
Description: class Prism::AssocNode: value pair.
Keywords: ruby,class,Prism::AssocNode

🔍

No recent searches

# class Prism::AssocNode

Represents a hash key/value pair.

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

### Attributes

key [R]

The key of the association. This can be any non-void expression.

    { a: b }
      ^

    { foo => bar }
      ^^^

    { def a; end => 1 }
      ^^^^^^^^^^

value [R]

The value of the association, if present. This can be any non-void expression.

    { foo => bar }
             ^^^

    { x: 1 }
         ^

### Public Class Methods

new (source, node_id, location, flags, key, value, operator_loc)
Source

    # File lib/prism/node.rb, line 1258
    def initialize(source, node_id, location, flags, key, value, operator_loc)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @key = key
      @value = value
      @operator_loc = operator_loc
    end

Initialize a new `AssocNode` node.

type ()
Source

    # File lib/prism/node.rb, line 1368
    def self.type
      :assoc_node
    end

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

### Public Instance Methods

=== (other)
Source

    # File lib/prism/node.rb, line 1374
    def ===(other)
      other.is_a?(AssocNode) &&
        (key === other.key) &&
        (value === other.value) &&
        (operator_loc.nil? == other.operator_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 1269
    def accept(visitor)
      visitor.visit_assoc_node(self)
    end

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

child_nodes ()
Source

    # File lib/prism/node.rb, line 1274
    def child_nodes
      [key, value]
    end

def `child_nodes`: () -> Array

Also aliased as: deconstruct
comment_targets ()
Source

    # File lib/prism/node.rb, line 1292
    def comment_targets
      [key, value, *operator_loc] #: Array[Prism::node | Location]
    end

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

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 1287
    def compact_child_nodes
      [key, value]
    end

def `compact_child_nodes`: () -> Array

copy (node_id: self.node_id, location: self.location, flags: self.flags, key: self.key, value: self.value, operator_loc: self.operator_loc)
Source

    # File lib/prism/node.rb, line 1297
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, key: self.key, value: self.value, operator_loc: self.operator_loc)
      AssocNode.new(source, node_id, location, flags, key, value, operator_loc)
    end

def copy: (?node_id: `Integer`, ?location: `Location`, ?flags: `Integer`, ?key: Prism::node, ?value: Prism::node, ?operator_loc: `Location`?) -> `AssocNode`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

    # File lib/prism/node.rb, line 1305
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, key: key, value: value, operator_loc: operator_loc }
    end

def `deconstruct_keys`: (Array keys) -> { node_id: `Integer`, location: `Location`, key: Prism::node, value: Prism::node, `operator_loc`: `Location`? }

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

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

      yield key
      yield value
    end

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

inspect ()
Source

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

def inspect -> `String`

operator ()
Source

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

def operator: () -> `String`?

operator_loc ()
Source

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

The location of the `=>` operator, if present.

    { foo => bar }
          ^^

save_operator_loc (repository)
Source

    # File lib/prism/node.rb, line 1348
    def save_operator_loc(repository)
      repository.enter(node_id, :operator_loc) unless @operator_loc.nil?
    end

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

type ()
Source

    # File lib/prism/node.rb, line 1363
    def type
      :assoc_node
    end

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