Represents an optional keyword parameter to a method, block, or lambda definition.
def a(b: 1)
^^^^
end
attr_reader value: Prism::node
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 14075
def initialize(source, flags, name, name_loc, value, location)
@source = source
@location = location
@flags = flags
@name = name
@name_loc = name_loc
@value = value
end
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 14168
def self.type
:optional_keyword_parameter_node
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 tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 14174
def ===(other)
other.is_a?(OptionalKeywordParameterNode) &&
(flags === other.flags) &&
(name === other.name) &&
(name_loc.nil? == other.name_loc.nil?) &&
(value === other.value)
end
Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 14085
def accept(visitor)
visitor.visit_optional_keyword_parameter_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 14090
def child_nodes
[value]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 14100
def comment_targets
[name_loc, value] #: Array[Prism::node | Location]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 14095
def compact_child_nodes
[value]
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 14105
def copy(flags: self.flags, name: self.name, name_loc: self.name_loc, value: self.value, location: self.location)
OptionalKeywordParameterNode.new(source, flags, name, name_loc, value, location)
end
def copy: (?flags: Integer, ?name: Symbol, ?name_loc: Location, ?value: Prism::node, ?location: Location) -> OptionalKeywordParameterNode
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 14113
def deconstruct_keys(keys)
{ flags: flags, name: name, name_loc: name_loc, value: value, location: location }
end
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 14140
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 14125
def name_loc
location = @name_loc
return location if location.is_a?(Location)
@name_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 14135
def repeated_parameter?
flags.anybits?(ParameterFlags::REPEATED_PARAMETER)
end
def repeated_parameter?: () -> bool
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 14158
def type
:optional_keyword_parameter_node
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