123456789_123456789_123456789_123456789_123456789_

Class: Prism::ReturnNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, PrismNode
Instance Chain:
self, PrismNode
Inherits: PrismNode
Defined in: lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents the use of the return keyword.

return 1
^^^^^^^^

Class Method Summary

Instance Attribute Summary

  • #arguments readonly

    attr_reader arguments: ArgumentsNode?

Instance Method Summary

Constructor Details

.new(source, node_id, location, flags, keyword_loc, arguments) ⇒ ReturnNode

Initialize a new ReturnNode node.

[ GitHub ] 

  


# File 'lib/prism/node.rb', line 14237



def initialize(source, node_id, location, flags, keyword_loc, arguments)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @keyword_loc = keyword_loc
  @arguments = arguments
end


  







Class Method Details



  

    .type  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 14306



def self.type
  :return_node
end


  







Instance Attribute Details



  

    #arguments   (readonly)
  



  

    
attr_reader arguments: ArgumentsNode?

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 14289



attr_reader :arguments


  







Instance Method Details



  

    #===(other)  
  



  

    
Implements case-equality for the node. This is effectively == but without
comparing the value of locations. Locations are checked only for presence.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 14312



def ===(other)
  other.is_a?(ReturnNode) &&
    (keyword_loc.nil? == other.keyword_loc.nil?) &&
    (arguments === other.arguments)
end


  








  

    #accept(visitor)  
  



  

    
def accept: (Visitor visitor) -> void

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 14247



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


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 14252



def child_nodes
  [arguments]
end


  








  

    #comment_targets  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 14264



def comment_targets
  [keyword_loc, *arguments] #: Array[Prism::node | Location]
end


  








  

    #compact_child_nodes  
  



  

    
def compact_child_nodes: () -> Array

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 14257



def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << arguments if arguments
  compact
end


  








  

    #copy(node_id: self.node_id, location: self.location, flags: self.flags, keyword_loc: self.keyword_loc, arguments: self.arguments)  
  



  

    
def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?keyword_loc: Location, ?arguments: ArgumentsNode?) -> ReturnNode

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 14269



def copy(node_id: self.node_id, location: self.location, flags: self.flags, keyword_loc: self.keyword_loc, arguments: self.arguments)
  ReturnNode.new(source, node_id, location, flags, keyword_loc, arguments)
end


  








  

    #deconstruct  
  



  

    
Alias for #child_nodes.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 14274



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

    
def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, keyword_loc: Location, arguments: ArgumentsNode? }

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 14277



def deconstruct_keys(keys)
  { node_id: node_id, location: location, keyword_loc: keyword_loc, arguments: arguments }
end


  








  

    #inspect  
  



  

    
def inspect -> String

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 14296



def inspect
  InspectVisitor.compose(self)
end


  








  

    #keyword  
  



  

    
def keyword: () -> String

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 14291



def keyword
  keyword_loc.slice
end


  








  

    #keyword_loc  
  



  

    
attr_reader keyword_loc: Location

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 14282



def keyword_loc
  location = @keyword_loc
  return location if location.is_a?(Location)
  @keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end


  








  

    #type  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 14301



def type
  :return_node
end