Class: Prism::RequiredParameterNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents a required parameter to a method, block, or lambda definition.

def a(b)
      ^
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, location) ⇒ RequiredParameterNode

def initialize: (name: Symbol, location: Location) -> void



12015
12016
12017
12018
 
# File 'lib/prism/node.rb', line 12015

def initialize(name, location)
  @name = name
  @location = location
end

Instance Attribute Details

#name ⇒ Object (readonly)

attr_reader name: Symbol



12012
12013
12014
 
# File 'lib/prism/node.rb', line 12012

def name
  @name
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



12021
12022
12023
 
# File 'lib/prism/node.rb', line 12021

def accept(visitor)
  visitor.visit_required_parameter_node(self)
end

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array[nil | Node]



12026
12027
12028
 
# File 'lib/prism/node.rb', line 12026

def child_nodes
  []
end

#comment_targets ⇒ Object

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



12036
12037
12038
 
# File 'lib/prism/node.rb', line 12036

def comment_targets
  []
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



12031
12032
12033
 
# File 'lib/prism/node.rb', line 12031

def compact_child_nodes
  []
end

#copy(**params) ⇒ Object

def copy: (**params) -> RequiredParameterNode



12041
12042
12043
12044
12045
12046
 
# File 'lib/prism/node.rb', line 12041

def copy(**params)
  RequiredParameterNode.new(
    params.fetch(:name) { name },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]



12052
12053
12054
 
# File 'lib/prism/node.rb', line 12052

def deconstruct_keys(keys)
  { name: name, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object 



12056
12057
12058
12059
12060
 
# File 'lib/prism/node.rb', line 12056

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "└── name: #{name.inspect}\n"
  inspector.to_str
end

#type ⇒ Object

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



12076
12077
12078
 
# File 'lib/prism/node.rb', line 12076

def type
  :required_parameter_node
end