Class: Prism::ConstantReadNode
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
Node
|
|
Instance Chain:
self,
Node
|
|
Inherits: |
Prism::Node
|
Defined in: | lib/prism/node.rb, lib/prism/node_ext.rb |
Overview
Represents referencing a constant.
Foo
^^^
Class Method Summary
-
.new(name, location) ⇒ ConstantReadNode
constructor
def initialize: (name: Symbol, location:
Location
) -> void. -
.type
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.
Instance Attribute Summary
Instance Method Summary
-
#accept(visitor)
def accept: (visitor:
Visitor
) -> void. -
#child_nodes
(also: #deconstruct)
def child_nodes: () -> Array[nil | Node].
-
#comment_targets
def comment_targets: () -> Array[Node | Location].
-
#compact_child_nodes
def compact_child_nodes: () -> Array.
-
#copy(**params)
def copy: (**params) ->
ConstantReadNode
. -
#deconstruct
Alias for #child_nodes.
- #deconstruct_keys(keys)
-
#full_name
Returns the full name of this constant.
-
#full_name_parts
Returns the list of parts for the full name of this constant.
-
#inspect(inspector = NodeInspector.new)
def inspect(inspector: NodeInspector) -> String.
-
#type
Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform.
Node
- Inherited
#pretty_print | Similar to inspect, but respects the current level of indentation given by the pretty print object. |
#slice | Slice the location of the node from the source. |
#to_dot | Convert this node into a graphviz dot graph string. |
#deprecated, #newline!, #set_newline_flag |
Constructor Details
.new(name, location) ⇒ ConstantReadNode
def initialize: (name: Symbol, location: Location
) -> void
Class Method Details
.type
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 'lib/prism/node.rb', line 5031
def self.type :constant_read_node end
Instance Attribute Details
#name (readonly)
attr_reader name: Symbol
# File 'lib/prism/node.rb', line 4956
attr_reader :name
Instance Method Details
#accept(visitor)
def accept: (visitor: Visitor
) -> void
# File 'lib/prism/node.rb', line 4965
def accept(visitor) visitor.visit_constant_read_node(self) end
#child_nodes Also known as: #deconstruct
def child_nodes: () -> Array[nil | Node]
# File 'lib/prism/node.rb', line 4970
def child_nodes [] end
#comment_targets
def comment_targets: () -> Array[Node | Location]
# File 'lib/prism/node.rb', line 4980
def comment_targets [] end
#compact_child_nodes
def compact_child_nodes: () -> Array
# File 'lib/prism/node.rb', line 4975
def compact_child_nodes [] end
#copy(**params)
def copy: (**params) -> ConstantReadNode
#deconstruct
Alias for #child_nodes.
# File 'lib/prism/node.rb', line 4993
alias deconstruct child_nodes
#deconstruct_keys(keys)
# File 'lib/prism/node.rb', line 4996
def deconstruct_keys(keys) { name: name, location: location } end
#full_name
Returns the full name of this constant. For example: “Foo”
# File 'lib/prism/node_ext.rb', line 118
def full_name name.to_s end
#full_name_parts
Returns the list of parts for the full name of this constant. For example: [:Foo]
# File 'lib/prism/node_ext.rb', line 113
def full_name_parts [name] end
#inspect(inspector = NodeInspector.new)
def inspect(inspector: NodeInspector) -> String
#type
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 'lib/prism/node.rb', line 5021
def type :constant_read_node end