Represents a method definition.
def method end ^^^^^^^^^^
attr_reader receiver: Prism::node?
attr_reader parameters: ParametersNode?
attr_reader body: Prism::node?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5795
def initialize(source, name, name_loc, receiver, parameters, body, locals, def_keyword_loc, operator_loc, lparen_loc, rparen_loc, equal_loc, end_keyword_loc, location)
@source = source
@location = location
@name = name
@name_loc = name_loc
@receiver = receiver
@parameters = parameters
@body = body
@locals = locals
@def_keyword_loc = def_keyword_loc
@operator_loc = operator_loc
@lparen_loc = lparen_loc
@rparen_loc = rparen_loc
@equal_loc = equal_loc
@end_keyword_loc = end_keyword_loc
end
def initialize: (Symbol name, Location name_loc, Prism::node? receiver, ParametersNode? parameters, Prism::node? body, Array locals, Location def_keyword_loc, Location? operator_loc, Location? lparen_loc, Location? rparen_loc, Location? equal_loc, Location? end_keyword_loc, Location location) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 6002
def self.type
:def_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 6008
def ===(other)
other.is_a?(DefNode) &&
(name === other.name) &&
(name_loc.nil? == other.name_loc.nil?) &&
(receiver === other.receiver) &&
(parameters === other.parameters) &&
(body === other.body) &&
(locals.length == other.locals.length) &&
locals.zip(other.locals).all? { |left, right| left === right } &&
(def_keyword_loc.nil? == other.def_keyword_loc.nil?) &&
(operator_loc.nil? == other.operator_loc.nil?) &&
(lparen_loc.nil? == other.lparen_loc.nil?) &&
(rparen_loc.nil? == other.rparen_loc.nil?) &&
(equal_loc.nil? == other.equal_loc.nil?) &&
(end_keyword_loc.nil? == other.end_keyword_loc.nil?)
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 5813
def accept(visitor)
visitor.visit_def_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5818
def child_nodes
[receiver, parameters, body]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5832
def comment_targets
[name_loc, *receiver, *parameters, *body, def_keyword_loc, *operator_loc, *lparen_loc, *rparen_loc, *equal_loc, *end_keyword_loc] #: Array[Prism::node | Location]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5823
def compact_child_nodes
compact = [] #: Array[Prism::node]
compact << receiver if receiver
compact << parameters if parameters
compact << body if body
compact
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5837
def copy(name: self.name, name_loc: self.name_loc, receiver: self.receiver, parameters: self.parameters, body: self.body, locals: self.locals, def_keyword_loc: self.def_keyword_loc, operator_loc: self.operator_loc, lparen_loc: self.lparen_loc, rparen_loc: self.rparen_loc, equal_loc: self.equal_loc, end_keyword_loc: self.end_keyword_loc, location: self.location)
DefNode.new(source, name, name_loc, receiver, parameters, body, locals, def_keyword_loc, operator_loc, lparen_loc, rparen_loc, equal_loc, end_keyword_loc, location)
end
def copy: (?name: Symbol, ?name_loc: Location, ?receiver: Prism::node?, ?parameters: ParametersNode?, ?body: Prism::node?, ?locals: Array, ?def_keyword_loc: Location, ?operator_loc: Location?, ?lparen_loc: Location?, ?rparen_loc: Location?, ?equal_loc: Location?, ?end_keyword_loc: Location?, ?location: Location) -> DefNode
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5845
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, receiver: receiver, parameters: parameters, body: body, locals: locals, def_keyword_loc: def_keyword_loc, operator_loc: operator_loc, lparen_loc: lparen_loc, rparen_loc: rparen_loc, equal_loc: equal_loc, end_keyword_loc: end_keyword_loc, location: location }
end
def deconstruct_keys: (Array keys) -> { name: Symbol, name_loc: Location, receiver: Prism::node?, parameters: ParametersNode?, body: Prism::node?, locals: Array, def_keyword_loc: Location, operator_loc: Location?, lparen_loc: Location?, rparen_loc: Location?, equal_loc: Location?, end_keyword_loc: Location?, location: Location }
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5944
def def_keyword
def_keyword_loc.slice
end
def def_keyword: () -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5872
def def_keyword_loc
location = @def_keyword_loc
return location if location.is_a?(Location)
@def_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
attr_reader def_keyword_loc: Location
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5969
def end_keyword
end_keyword_loc&.slice
end
def end_keyword: () -> String?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5931
def end_keyword_loc
location = @end_keyword_loc
case location
when nil
nil
when Location
location
else
@end_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
end
attr_reader end_keyword_loc: Location?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5964
def equal
equal_loc&.slice
end
def equal: () -> String?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5918
def equal_loc
location = @equal_loc
case location
when nil
nil
when Location
location
else
@equal_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
end
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5974
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5954
def lparen
lparen_loc&.slice
end
def lparen: () -> String?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5892
def lparen_loc
location = @lparen_loc
case location
when nil
nil
when Location
location
else
@lparen_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
end
attr_reader lparen_loc: Location?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5853
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 5949
def operator
operator_loc&.slice
end
def operator: () -> String?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5879
def operator_loc
location = @operator_loc
case location
when nil
nil
when Location
location
else
@operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
end
attr_reader operator_loc: Location?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5959
def rparen
rparen_loc&.slice
end
def rparen: () -> String?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5905
def rparen_loc
location = @rparen_loc
case location
when nil
nil
when Location
location
else
@rparen_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
end
attr_reader rparen_loc: Location?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5992
def type
:def_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