Class: RBI::Sig

Inherits:

NodeWithComments

• Object
• Node
• NodeWithComments
• RBI::Sig

Defined in:

lib/rbi/model.rb

Overview

Sorbet's sigs

Instance Attribute Summary

• #allow_incompatible_override ⇒ Object
• #allow_incompatible_override_visibility ⇒ Object
• #checked ⇒ Object
• #is_abstract ⇒ Object
• #is_final ⇒ Object
• #is_overridable ⇒ Object
• #is_override ⇒ Object
• #return_type ⇒ Object
• #without_runtime ⇒ Object

Attributes inherited from NodeWithComments

#comments

Attributes inherited from Node

#loc, #parent_tree

Instance Method Summary

• #<<(param) ⇒ Object
• #==(other) ⇒ Object
• #add_param(name, type) ⇒ Object
• #initialize(params: nil, return_type: "void", is_abstract: false, is_override: false, is_overridable: false, is_final: false, allow_incompatible_override: false, allow_incompatible_override_visibility: false, without_runtime: false, type_params: nil, checked: nil, loc: nil, comments: nil, &block) ⇒ Sig constructor

  A new instance of Sig.

• #params ⇒ Object
• #type_params ⇒ Object
• #type_params? ⇒ Boolean

Methods inherited from NodeWithComments

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

Methods inherited from Node

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

Constructor Details

#initialize(params: nil, return_type: "void", is_abstract: false, is_override: false, is_overridable: false, is_final: false, allow_incompatible_override: false, allow_incompatible_override_visibility: false, without_runtime: false, type_params: nil, checked: nil, loc: nil, comments: nil, &block) ⇒ Sig

Returns a new instance of Sig.

Signature:

• (

• ?params: Array[SigParam]?,

• ?return_type: (Type | String),

• ?is_abstract: bool,

• ?is_override: bool,

• ?is_overridable: bool,

• ?is_final: bool,

• ?allow_incompatible_override: bool,

• ?allow_incompatible_override_visibility: bool,

• ?without_runtime: bool,

• ?type_params: Array[String]?,

• ?checked: Symbol?,

• ?loc: Loc?,

• ?comments: Array[Comment]?

• ) ?{ (Sig node) -> void } -> void

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

def initialize(
  params: nil,
  return_type: "void",
  is_abstract: false,
  is_override: false,
  is_overridable: false,
  is_final: false,
  allow_incompatible_override: false,
  allow_incompatible_override_visibility: false,
  without_runtime: false,
  type_params: nil,
  checked: nil,
  loc: nil,
  comments: nil,
  &block
)
  super(loc: loc, comments: comments)
  @params = params #: Array[SigParam]?
  @return_type = return_type
  @is_abstract = is_abstract
  @is_override = is_override
  @is_overridable = is_overridable
  @is_final = is_final
  @allow_incompatible_override = allow_incompatible_override
  @allow_incompatible_override_visibility = allow_incompatible_override_visibility
  @without_runtime = without_runtime
  @type_params = type_params #: Array[String]?
  @checked = checked
  block&.call(self)
end

Instance Attribute Details

#allow_incompatible_override ⇒ Object

Signature:

• bool

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

def allow_incompatible_override
  @allow_incompatible_override
end

#allow_incompatible_override_visibility ⇒ Object

Signature:

• bool

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

def allow_incompatible_override_visibility
  @allow_incompatible_override_visibility
end

#checked ⇒ Object

Signature:

• Symbol?

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

def checked
  @checked
end

#is_abstract ⇒ Object

Signature:

• bool

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

def is_abstract
  @is_abstract
end

#is_final ⇒ Object

Signature:

• bool

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

def is_final
  @is_final
end

#is_overridable ⇒ Object

Signature:

• bool

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

def is_overridable
  @is_overridable
end

#is_override ⇒ Object

Signature:

• bool

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

def is_override
  @is_override
end

#return_type ⇒ Object

Signature:

• (Type | String)

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

def return_type
  @return_type
end

#without_runtime ⇒ Object

Signature:

• bool

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

def without_runtime
  @without_runtime
end

Instance Method Details

#<<(param) ⇒ Object

Signature:

• (SigParam param) -> void

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

def <<(param)
  params << param
end

#==(other) ⇒ Object

Signature:

• (Object other) -> bool

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

def ==(other)
  return false unless other.is_a?(Sig)

  params == other.params && return_type.to_s == other.return_type.to_s && is_abstract == other.is_abstract &&
    is_override == other.is_override && is_overridable == other.is_overridable && is_final == other.is_final &&
    without_runtime == other.without_runtime && type_params == other.type_params && checked == other.checked
end

#add_param(name, type) ⇒ Object

Signature:

• (String name, (Type | String) type) -> void

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

def add_param(name, type)
  params << SigParam.new(name, type)
end

#params ⇒ Object

Signature:

• -> Array[SigParam]

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

def params
  @params ||= []
end

#type_params ⇒ Object

Signature:

• -> Array[String]

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

def type_params
  @type_params ||= []
end

#type_params? ⇒ Boolean

Signature:

• -> bool

Returns:

• (Boolean)

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

def type_params?
  !@type_params.nil? && !@type_params.empty?
end