class Prism::RequiredParameterNode

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

def a(b)
      ^
end

Attributes

flags[R]

private attr_reader flags: Integer

name[R]

attr_reader name: Symbol

Public Class Methods

new(source, flags, name, location) click to toggle source

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

# File lib/prism/node.rb, line 15733
def initialize(source, flags, name, location)
  @source = source
  @newline = false
  @location = location
  @flags = flags
  @name = name
end
type() click to toggle source

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 15820
def self.type
  :required_parameter_node
end

Public Instance Methods

accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

# File lib/prism/node.rb, line 15742
def accept(visitor)
  visitor.visit_required_parameter_node(self)
end
child_nodes() click to toggle source

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

# File lib/prism/node.rb, line 15747
def child_nodes
  []
end
Also aliased as: deconstruct
comment_targets() click to toggle source

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

# File lib/prism/node.rb, line 15757
def comment_targets
  [] #: Array[Prism::node | Location]
end
compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File lib/prism/node.rb, line 15752
def compact_child_nodes
  []
end
copy(flags: self.flags, name: self.name, location: self.location) click to toggle source

def copy: (?flags: Integer, ?name: Symbol, ?location: Location) -> RequiredParameterNode

# File lib/prism/node.rb, line 15762
def copy(flags: self.flags, name: self.name, location: self.location)
  RequiredParameterNode.new(source, flags, name, location)
end
deconstruct()

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

Alias for: child_nodes
deconstruct_keys(keys) click to toggle source

def deconstruct_keys: (Array keys) -> { flags: Integer, name: Symbol, location: Location }

# File lib/prism/node.rb, line 15770
def deconstruct_keys(keys)
  { flags: flags, name: name, location: location }
end
inspect(inspector = NodeInspector.new) click to toggle source

def inspect(NodeInspector inspector) -> String

# File lib/prism/node.rb, line 15788
def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  flags = [("repeated_parameter" if repeated_parameter?)].compact
  inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
  inspector << "└── name: #{name.inspect}\n"
  inspector.to_str
end
repeated_parameter?() click to toggle source

def repeated_parameter?: () -> bool

# File lib/prism/node.rb, line 15783
def repeated_parameter?
  flags.anybits?(ParameterFlags::REPEATED_PARAMETER)
end
type() click to toggle source

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 15810
def type
  :required_parameter_node
end