class Prism::DefNode - Documentation for Ruby 3.4
Description: class Prism::DefNode: Represents a method definition.
Keywords: ruby,class,Prism::DefNode

# class Prism::DefNode

Represents a method definition.

    def method
    end
    ^^^^^^^^^^

### Attributes

body [R]

attr_reader body: `StatementsNode` | `BeginNode` | nil

locals [R]

attr_reader locals: Array

name [R]

attr_reader name: `Symbol`

parameters [R]

attr_reader parameters: `ParametersNode`?

receiver [R]

attr_reader receiver: Prism::node?

### Public Class Methods

new (source, node_id, location, flags, name, name_loc, receiver, parameters, body, locals, def_keyword_loc, operator_loc, lparen_loc, rparen_loc, equal_loc, end_keyword_loc)
Source

    # File lib/prism/node.rb, line 5918
    def initialize(source, node_id, location, flags, name, name_loc, receiver, parameters, body, locals, def_keyword_loc, operator_loc, lparen_loc, rparen_loc, equal_loc, end_keyword_loc)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @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

Initialize a new `DefNode` node.

type ()
Source

    # File lib/prism/node.rb, line 6151
    def self.type
      :def_node
    end

Return a symbol representation of this node type. See `Node::type`.

### Public Instance Methods

=== (other)
Source

    # File lib/prism/node.rb, line 6157
    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.

accept (visitor)
Source

    # File lib/prism/node.rb, line 5938
    def accept(visitor)
      visitor.visit_def_node(self)
    end

def accept: (`Visitor` visitor) -> void

child_nodes ()
Source

    # File lib/prism/node.rb, line 5943
    def child_nodes
      [receiver, parameters, body]
    end

def `child_nodes`: () -> Array

Also aliased as: deconstruct
comment_targets ()
Source

    # File lib/prism/node.rb, line 5957
    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]

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 5948
    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

copy (node_id: self.node_id, location: self.location, flags: self.flags, 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)
Source

    # File lib/prism/node.rb, line 5962
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, 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)
      DefNode.new(source, node_id, location, flags, name, name_loc, receiver, parameters, body, locals, def_keyword_loc, operator_loc, lparen_loc, rparen_loc, equal_loc, end_keyword_loc)
    end

def copy: (?node_id: `Integer`, ?location: `Location`, ?flags: `Integer`, ?name: `Symbol`, ?name_loc: `Location`, ?receiver: Prism::node?, ?parameters: `ParametersNode`?, ?body: `StatementsNode` | `BeginNode` | nil, ?locals: Array, ?def_keyword_loc: `Location`, ?operator_loc: `Location`?, ?lparen_loc: `Location`?, ?rparen_loc: `Location`?, ?equal_loc: `Location`?, ?end_keyword_loc: `Location`?) -> `DefNode`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

    # File lib/prism/node.rb, line 5970
    def deconstruct_keys(keys)
      { node_id: node_id, 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 `deconstruct_keys`: (Array keys) -> { node_id: `Integer`, location: `Location`, name: `Symbol`, `name_loc`: `Location`, receiver: Prism::node?, parameters: `ParametersNode`?, body: `StatementsNode` | `BeginNode` | nil, locals: Array, `def_keyword_loc`: `Location`, `operator_loc`: `Location`?, `lparen_loc`: `Location`?, `rparen_loc`: `Location`?, `equal_loc`: `Location`?, `end_keyword_loc`: `Location`? }

def_keyword ()
Source

    # File lib/prism/node.rb, line 6111
    def def_keyword
      def_keyword_loc.slice
    end

def `def_keyword`: () -> `String`

def_keyword_loc ()
Source

    # File lib/prism/node.rb, line 6003
    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`

end_keyword ()
Source

    # File lib/prism/node.rb, line 6136
    def end_keyword
      end_keyword_loc&.slice
    end

def `end_keyword`: () -> `String`?

end_keyword_loc ()
Source

    # File lib/prism/node.rb, line 6092
    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`?

equal ()
Source

    # File lib/prism/node.rb, line 6131
    def equal
      equal_loc&.slice
    end

def equal: () -> `String`?

equal_loc ()
Source

    # File lib/prism/node.rb, line 6073
    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

attr_reader `equal_loc`: `Location`?

inspect ()
Source

    # File lib/prism/node.rb, line 6141
    def inspect
      InspectVisitor.compose(self)
    end

def inspect -> `String`

lparen ()
Source

    # File lib/prism/node.rb, line 6121
    def lparen
      lparen_loc&.slice
    end

def lparen: () -> `String`?

lparen_loc ()
Source

    # File lib/prism/node.rb, line 6035
    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`?

name_loc ()
Source

    # File lib/prism/node.rb, line 5978
    def name_loc
      location = @name_loc
      return location if location.is_a?(Location)
      @name_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
    end

attr_reader `name_loc`: `Location`

operator ()
Source

    # File lib/prism/node.rb, line 6116
    def operator
      operator_loc&.slice
    end

def operator: () -> `String`?

operator_loc ()
Source

    # File lib/prism/node.rb, line 6016
    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`?

rparen ()
Source

    # File lib/prism/node.rb, line 6126
    def rparen
      rparen_loc&.slice
    end

def rparen: () -> `String`?

rparen_loc ()
Source

    # File lib/prism/node.rb, line 6054
    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`?

save_def_keyword_loc (repository)
Source

    # File lib/prism/node.rb, line 6011
    def save_def_keyword_loc(repository)
      repository.enter(node_id, :def_keyword_loc)
    end

Save the `def_keyword_loc` location using the given saved source so that it can be retrieved later.

save_end_keyword_loc (repository)
Source

    # File lib/prism/node.rb, line 6106
    def save_end_keyword_loc(repository)
      repository.enter(node_id, :end_keyword_loc) unless @end_keyword_loc.nil?
    end

Save the `end_keyword_loc` location using the given saved source so that it can be retrieved later.

save_equal_loc (repository)
Source

    # File lib/prism/node.rb, line 6087
    def save_equal_loc(repository)
      repository.enter(node_id, :equal_loc) unless @equal_loc.nil?
    end

Save the `equal_loc` location using the given saved source so that it can be retrieved later.

save_lparen_loc (repository)
Source

    # File lib/prism/node.rb, line 6049
    def save_lparen_loc(repository)
      repository.enter(node_id, :lparen_loc) unless @lparen_loc.nil?
    end

Save the `lparen_loc` location using the given saved source so that it can be retrieved later.

save_name_loc (repository)
Source

    # File lib/prism/node.rb, line 5986
    def save_name_loc(repository)
      repository.enter(node_id, :name_loc)
    end

Save the `name_loc` location using the given saved source so that it can be retrieved later.

save_operator_loc (repository)
Source

    # File lib/prism/node.rb, line 6030
    def save_operator_loc(repository)
      repository.enter(node_id, :operator_loc) unless @operator_loc.nil?
    end

Save the `operator_loc` location using the given saved source so that it can be retrieved later.

save_rparen_loc (repository)
Source

    # File lib/prism/node.rb, line 6068
    def save_rparen_loc(repository)
      repository.enter(node_id, :rparen_loc) unless @rparen_loc.nil?
    end

Save the `rparen_loc` location using the given saved source so that it can be retrieved later.

type ()
Source

    # File lib/prism/node.rb, line 6146
    def type
      :def_node
    end

Return a symbol representation of this node type. See `Node#type`.