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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, location) ⇒ RequiredParameterNode

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



14568
14569
14570
14571
 
# File 'lib/prism/node.rb', line 14568

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

Instance Attribute Details

#name ⇒ Object (readonly)

attr_reader name: Symbol



14565
14566
14567
 
# File 'lib/prism/node.rb', line 14565

def name
  @name
end

Class Method Details

.type ⇒ Object

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



14640
14641
14642
 
# File 'lib/prism/node.rb', line 14640

def self.type
  :required_parameter_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



14574
14575
14576
 
# File 'lib/prism/node.rb', line 14574

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

#child_nodes ⇒ Object Also known as: deconstruct

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



14579
14580
14581
 
# File 'lib/prism/node.rb', line 14579

def child_nodes
  []
end

#comment_targets ⇒ Object

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



14589
14590
14591
 
# File 'lib/prism/node.rb', line 14589

def comment_targets
  []
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



14584
14585
14586
 
# File 'lib/prism/node.rb', line 14584

def compact_child_nodes
  []
end

#copy(**params) ⇒ Object

def copy: (**params) -> RequiredParameterNode



14594
14595
14596
14597
14598
14599
 
# File 'lib/prism/node.rb', line 14594

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]



14605
14606
14607
 
# File 'lib/prism/node.rb', line 14605

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



14610
14611
14612
14613
14614
 
# File 'lib/prism/node.rb', line 14610

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



14630
14631
14632
 
# File 'lib/prism/node.rb', line 14630

def type
  :required_parameter_node
end