Class: RBI::Struct

Inherits:
Scope show all
Defined in:
lib/rbi/model.rb,
lib/rbi/rewriters/merge_trees.rb

Instance Attribute Summary collapse

Attributes inherited from Tree

#nodes

Attributes inherited from NodeWithComments

#comments

Attributes inherited from Node

#loc, #parent_tree

Instance Method Summary collapse

Methods inherited from Scope

#dup_empty, #index_ids, #to_s

Methods included from Indexable

#index_ids

Methods inherited from Tree

#<<, #add_sig_templates!, #annotate!, #deannotate!, #empty?, #filter_versions!, #flatten_singleton_methods!, #flatten_visibilities!, #group_nodes!, #index, #merge, #nest_non_public_members!, #nest_singleton_methods!, #nest_top_level_members!, #replace_attributes_with_methods!, #sort_nodes!, #translate_rbs_sigs!

Methods inherited from NodeWithComments

#annotations, #comments?, #merge_with, #version_requirements

Methods inherited from Node

#detach, #merge_with, #parent_conflict_tree, #parent_scope, #print, #rbs_print, #rbs_string, #replace, #satisfies_version?, #string

Constructor Details

#initialize(name, members: [], keyword_init: false, loc: nil, comments: nil, &block) ⇒ Struct

Returns a new instance of Struct.

Signature:

  • (

  • String name,

  • ?members: Array[Symbol],

  • ?keyword_init: bool,

  • ?loc: Loc?,

  • ?comments: Array[Comment]?

  • ) ?{ (Struct struct) -> void } -> void



277
278
279
280
281
282
283
 
# File 'lib/rbi/model.rb', line 277

def initialize(name, members: [], keyword_init: false, loc: nil, comments: nil, &block)
  super(loc: loc, comments: comments) {}
  @name = name.to_s #: String
  @members = members
  @keyword_init = keyword_init
  block&.call(self)
end

Instance Attribute Details

#keyword_init ⇒ Object

Signature:

  • bool



268
269
270
 
# File 'lib/rbi/model.rb', line 268

def keyword_init
  @keyword_init
end

#members ⇒ Object

Signature:

  • Array[Symbol]



265
266
267
 
# File 'lib/rbi/model.rb', line 265

def members
  @members
end

#name ⇒ Object (readonly)

Signature:

  • String



262
263
264
 
# File 'lib/rbi/model.rb', line 262

def name
  @name
end

Instance Method Details

#compatible_with?(other) ⇒ Boolean

Signature:

  • (Node other) -> bool

Returns:

  • (Boolean) 


404
405
406
 
# File 'lib/rbi/rewriters/merge_trees.rb', line 404

def compatible_with?(other)
  other.is_a?(Struct) && members == other.members && keyword_init == other.keyword_init
end

#fully_qualified_name ⇒ Object

Signature:

  • -> String



287
288
289
290
291
 
# File 'lib/rbi/model.rb', line 287

def fully_qualified_name
  return name if name.start_with?("::")

  "#{parent_scope&.fully_qualified_name}::#{name}"
end