class Prism::ConstantReadNode
Represents referencing a constant.
Foo ^^^
Attributes
attr_reader name: Symbol
Public Class Methods
def initialize: (name: Symbol, location: Location
) -> void
# File prism/node.rb, line 4959 def initialize(name, location) @name = name @location = location 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 prism/node.rb, line 5031 def self.type :constant_read_node end
Public Instance Methods
def accept: (visitor: Visitor
) -> void
# File prism/node.rb, line 4965 def accept(visitor) visitor.visit_constant_read_node(self) end
def child_nodes
: () -> Array[nil | Node]
# File prism/node.rb, line 4970 def child_nodes [] end
def comment_targets
: () -> Array[Node | Location]
# File prism/node.rb, line 4980 def comment_targets [] end
def compact_child_nodes
: () -> Array
# File prism/node.rb, line 4975 def compact_child_nodes [] end
def copy: (**params) -> ConstantReadNode
# File prism/node.rb, line 4985 def copy(**params) ConstantReadNode.new( params.fetch(:name) { name }, params.fetch(:location) { location }, ) end
Returns the full name of this constant. For example: “Foo”
# File prism/node_ext.rb, line 96 def full_name name.name end
Returns the list of parts for the full name of this constant. For example: [:Foo]
# File prism/node_ext.rb, line 91 def full_name_parts [name] end
def inspect(inspector: NodeInspector) -> String
# File prism/node.rb, line 5001 def inspect(inspector = NodeInspector.new) inspector << inspector.header(self) inspector << "└── name: #{name.inspect}\n" inspector.to_str 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
# File prism/node.rb, line 5021 def type :constant_read_node end