Class: RBI::Struct

Inherits:

Scope

• Object
• Node
• NodeWithComments
• Tree
• Scope
• RBI::Struct

Defined in:

lib/rbi/model.rb,
lib/rbi/rewriters/merge_trees.rb

Instance Attribute Summary

• #keyword_init ⇒ Object

  : bool.

• #members ⇒ Object

  : Array.

• #name ⇒ Object readonly

  : String.

Attributes inherited from Tree

#nodes

Attributes inherited from NodeWithComments

#comments

Attributes inherited from Node

#loc, #parent_tree

Instance Method Summary

• #compatible_with?(other) ⇒ Boolean

  : (Node other) -> bool.

• #fully_qualified_name ⇒ Object

  : -> String.

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

  : ( | String name, | ?members: Array, | ?keyword_init: bool, | ?loc: Loc?, | ?comments: Array? | ) ?{ (Struct struct) -> void } -> void.

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

: ( | String name, | ?members: Array, | ?keyword_init: bool, | ?loc: Loc?, | ?comments: Array? | ) ?{ (Struct struct) -> void } -> void

# 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

: bool

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

def keyword_init
  @keyword_init
end

#members ⇒ Object

: Array

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

def members
  @members
end

#name ⇒ Object (readonly)

: String

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

def name
  @name
end

Instance Method Details

#compatible_with?(other) ⇒ Boolean

: (Node other) -> bool

Returns:

• (Boolean)

# 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

: -> String

# File 'lib/rbi/model.rb', line 287

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

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