Represents a hash literal.
{ a => b }
^^^^^^^^^^
The elements of the hash. These can be either ‘AssocNode`s or `AssocSplatNode`s.
{ a: b }
^^^^
{ **foo }
^^^^^
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 8189
def initialize(source, opening_loc, elements, closing_loc, location)
@source = source
@location = location
@opening_loc = opening_loc
@elements = elements
@closing_loc = closing_loc
end
def initialize: (Location opening_loc, Array[AssocNode | AssocSplatNode] elements, Location closing_loc, Location location) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 8298
def self.type
:hash_node
end
Similar to type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.
def self.type: () -> Symbol
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 8304
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.
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 8198
def accept(visitor)
visitor.visit_hash_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 8203
def child_nodes
[*elements]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 8265
def closing
closing_loc.slice
end
def closing: () -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 8253
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 }
^
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 8213
def comment_targets
[opening_loc, *elements, closing_loc] #: Array[Prism::node | Location]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 8208
def compact_child_nodes
[*elements]
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 8218
def copy(opening_loc: self.opening_loc, elements: self.elements, closing_loc: self.closing_loc, location: self.location)
HashNode.new(source, opening_loc, elements, closing_loc, location)
end
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 8226
def deconstruct_keys(keys)
{ opening_loc: opening_loc, elements: elements, closing_loc: closing_loc, location: location }
end
def deconstruct_keys: (Array keys) -> { opening_loc: Location, elements: Array[AssocNode | AssocSplatNode], closing_loc: Location, location: Location }
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 8270
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 8260
def opening
opening_loc.slice
end
def opening: () -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 8234
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 }
^
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 8288
def type
:hash_node
end
Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.
Instead, you can call type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.
def type: () -> Symbol