Class: RBI::TStructField Abstract

Inherits:

NodeWithComments

• Object
• Node
• NodeWithComments
• RBI::TStructField

Defined in:

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

Overview

This class is abstract.

Direct Known Subclasses

TStructConst, TStructProp

Instance Attribute Summary

• #default ⇒ Object
• #name ⇒ Object readonly
• #type ⇒ Object

Attributes inherited from NodeWithComments

#comments

Attributes inherited from Node

#loc, #parent_tree

Instance Method Summary

• #compatible_with?(other) ⇒ Boolean
• #fully_qualified_names ⇒ Object abstract
• #initialize(name, type, default: nil, loc: nil, comments: nil) ⇒ TStructField constructor

  A new instance of TStructField.

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, type, default: nil, loc: nil, comments: nil) ⇒ TStructField

Returns a new instance of TStructField.

Signature:

• (String name, (Type | String) type, ?default: String?, ?loc: Loc?, ?comments: Array[Comment]?) -> void

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

def initialize(name, type, default: nil, loc: nil, comments: nil)
  super(loc: loc, comments: comments)
  @name = name.to_s #: String
  @type = type
  @default = default
end

Instance Attribute Details

#default ⇒ Object

Signature:

• String?

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

def default
  @default
end

#name ⇒ Object (readonly)

Signature:

• String

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

def name
  @name
end

#type ⇒ Object

Signature:

• (Type | String)

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

def type
  @type
end

Instance Method Details

#compatible_with?(other) ⇒ Boolean

Signature:

• (Node other) -> bool

Returns:

• (Boolean)

# File 'lib/rbi/rewriters/merge_trees.rb', line 599

def compatible_with?(other)
  other.is_a?(TStructField) && name == other.name && type == other.type && default == other.default
end

#fully_qualified_names ⇒ Object

This method is abstract.

Signature:

• -> Array[String]

Raises:

• (NotImplementedError)

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

def fully_qualified_names = raise NotImplementedError, "Abstract method called"