class RBS::Types::Function - rbs: Ruby Standard Library Documentation

# class RBS::Types::Function

### Attributes

optional_keywords[R]
optional_positionals[R]
required_keywords[R]
required_positionals[R]
rest_keywords[R]
rest_positionals[R]
return_type[R]
trailing_positionals[R]

### Public Class Methods

empty(return_type) click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 1084
    def self.empty(return_type)
      Function.new(
        required_positionals: [],
        optional_positionals: [],
        rest_positionals: nil,
        trailing_positionals: [],
        required_keywords: {},
        optional_keywords: {},
        rest_keywords: nil,
        return_type: return_type
      )
    end

new(required_positionals:, optional_positionals:, rest_positionals:, trailing_positionals:, required_keywords:, optional_keywords:, rest_keywords:, return_type:) click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 934
    def initialize(required_positionals:, optional_positionals:, rest_positionals:, trailing_positionals:, required_keywords:, optional_keywords:, rest_keywords:, return_type:)
      @return_type = return_type
      @required_positionals = required_positionals
      @optional_positionals = optional_positionals
      @rest_positionals = rest_positionals
      @trailing_positionals = trailing_positionals
      @required_keywords = required_keywords
      @optional_keywords = optional_keywords
      @rest_keywords = rest_keywords
    end

### Public Instance Methods

==(other) click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 945
    def ==(other)
      other.is_a?(Function) &&
        other.required_positionals == required_positionals &&
        other.optional_positionals == optional_positionals &&
        other.rest_positionals == rest_positionals &&
        other.trailing_positionals == trailing_positionals &&
        other.required_keywords == required_keywords &&
        other.optional_keywords == optional_keywords &&
        other.rest_keywords == rest_keywords &&
        other.return_type == return_type
    end

Also aliased as: eql?
amap(array, &block) click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 1016
    def amap(array, &block)
      if array.empty?
        _ = array
      else
        array.map(&block)
      end
    end

drop_head() click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 1153
    def drop_head
      case
      when !required_positionals.empty?
        [
          required_positionals[0],
          update(required_positionals: required_positionals.drop(1))
        ]
      when !optional_positionals.empty?
        [
          optional_positionals[0],
          update(optional_positionals: optional_positionals.drop(1))
        ]
      else
        raise "Cannot #drop_head"
      end
    end

drop_tail() click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 1170
    def drop_tail
      case
      when !trailing_positionals.empty?
        last = trailing_positionals.last or raise
        [
          last,
          update(trailing_positionals: trailing_positionals.take(trailing_positionals.size - 1))
        ]
      else
        raise "Cannot #drop_tail"
      end
    end

each_param(&block) click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 1053
    def each_param(&block)
      if block
        required_positionals.each(&block)
        optional_positionals.each(&block)
        rest_positionals&.yield_self(&block)
        trailing_positionals.each(&block)
        required_keywords.each_value(&block)
        optional_keywords.each_value(&block)
        rest_keywords&.yield_self(&block)
      else
        enum_for :each_param
      end
    end

each_type() { |type| ... } click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 1038
    def each_type
      if block_given?
        required_positionals.each {|param| yield param.type }
        optional_positionals.each {|param| yield param.type }
        rest_positionals&.yield_self {|param| yield param.type }
        trailing_positionals.each {|param| yield param.type }
        required_keywords.each_value {|param| yield param.type }
        optional_keywords.each_value {|param| yield param.type }
        rest_keywords&.yield_self {|param| yield param.type }
        yield(return_type)
      else
        enum_for :each_type
      end
    end

empty?() click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 1124
    def empty?
      required_positionals.empty? &&
        optional_positionals.empty? &&
        !rest_positionals &&
        trailing_positionals.empty? &&
        required_keywords.empty? &&
        optional_keywords.empty? &&
        !rest_keywords
    end

eql?(other)
Alias for: ==
free_variables(set = Set.new) click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 971
    def free_variables(set = Set.new)
      set.tap do
        required_positionals.each do |param|
          param.type.free_variables(set)
        end
        optional_positionals.each do |param|
          param.type.free_variables(set)
        end
        rest_positionals&.yield_self do |param|
          param.type.free_variables(set)
        end
        trailing_positionals.each do |param|
          param.type.free_variables(set)
        end
        required_keywords.each_value do |param|
          param.type.free_variables(set)
        end
        optional_keywords.each_value do |param|
          param.type.free_variables(set)
        end
        rest_keywords&.yield_self do |param|
          param.type.free_variables(set)
        end

        return_type.free_variables(set)
      end
    end

has_classish_type?() click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 1195
    def has_classish_type?
      each_type.any? {|type| type.has_classish_type? }
    end

has_keyword?() click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 1183
    def has_keyword?
      if !required_keywords.empty? || !optional_keywords.empty? || rest_keywords
        true
      else
        false
      end
    end

has_self_type?() click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 1191
    def has_self_type?
      each_type.any? {|type| type.has_self_type? }
    end

hash() click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 959
    def hash
      self.class.hash ^
        required_positionals.hash ^
        optional_positionals.hash ^
        rest_positionals.hash ^
        trailing_positionals.hash ^
        required_keywords.hash ^
        optional_keywords.hash ^
        rest_keywords.hash ^
        return_type.hash
    end

hmapv(hash, &block) click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 1024
    def hmapv(hash, &block)
      if hash.empty?
        _ = hash
      else
        hash.transform_values(&block)
      end
    end

map_type() { |return_type| ... } click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 999
    def map_type(&block)
      if block
        Function.new(
          required_positionals: amap(required_positionals) {|param| param.map_type(&block) },
          optional_positionals: amap(optional_positionals) {|param| param.map_type(&block) },
          rest_positionals: rest_positionals&.yield_self {|param| param.map_type(&block) },
          trailing_positionals: amap(trailing_positionals) {|param| param.map_type(&block) },
          required_keywords: hmapv(required_keywords) {|param| param.map_type(&block) },
          optional_keywords: hmapv(optional_keywords) {|param| param.map_type(&block) },
          rest_keywords: rest_keywords&.yield_self {|param| param.map_type(&block) },
          return_type: yield(return_type)
        )
      else
        enum_for :map_type
      end
    end

map_type_name(&block) click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 1032
    def map_type_name(&block)
      map_type do |type|
        type.map_type_name(&block)
      end
    end

param_to_s() click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 1134
    def param_to_s
      # @type var params: Array[String]
      params = []

      params.push(*required_positionals.map(&:to_s))
      params.push(*optional_positionals.map {|p| "?#{p}"})
      params.push("*#{rest_positionals}") if rest_positionals
      params.push(*trailing_positionals.map(&:to_s))
      params.push(*required_keywords.map {|name, param| "#{name}: #{param}" })
      params.push(*optional_keywords.map {|name, param| "?#{name}: #{param}" })
      params.push("**#{rest_keywords}") if rest_keywords

      params.join(", ")
    end

return_to_s() click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 1149
    def return_to_s
      return_type.to_s(1)
    end

sub(s) click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 1080
    def sub(s)
      map_type {|ty| ty.sub(s) }
    end

to_json(state = _ = nil) click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 1067
    def to_json(state = _ = nil)
      {
        required_positionals: required_positionals,
        optional_positionals: optional_positionals,
        rest_positionals: rest_positionals,
        trailing_positionals: trailing_positionals,
        required_keywords: required_keywords,
        optional_keywords: optional_keywords,
        rest_keywords: rest_keywords,
        return_type: return_type
      }.to_json(state)
    end

update(required_positionals: self.required_positionals, optional_positionals: self.optional_positionals, rest_positionals: self.rest_positionals, trailing_positionals: self.trailing_positionals, required_keywords: self.required_keywords, optional_keywords: self.optional_keywords, rest_keywords: self.rest_keywords, return_type: self.return_type) click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 1110
    def update(required_positionals: self.required_positionals, optional_positionals: self.optional_positionals, rest_positionals: self.rest_positionals, trailing_positionals: self.trailing_positionals,
               required_keywords: self.required_keywords, optional_keywords: self.optional_keywords, rest_keywords: self.rest_keywords, return_type: self.return_type)
      Function.new(
        required_positionals: required_positionals,
        optional_positionals: optional_positionals,
        rest_positionals: rest_positionals,
        trailing_positionals: trailing_positionals,
        required_keywords: required_keywords,
        optional_keywords: optional_keywords,
        rest_keywords: rest_keywords,
        return_type: return_type
      )
    end

with_nonreturn_void?() click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 1199
    def with_nonreturn_void?
      if each_param.any? {|param| param.type.with_nonreturn_void? }
        true
      else
        if return_type.is_a?(Bases::Void)
          false
        else
          return_type.with_nonreturn_void?
        end
      end
    end

with_return_type(type) click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 1097
    def with_return_type(type)
      Function.new(
        required_positionals: required_positionals,
        optional_positionals: optional_positionals,
        rest_positionals: rest_positionals,
        trailing_positionals: trailing_positionals,
        required_keywords: required_keywords,
        optional_keywords: optional_keywords,
        rest_keywords: rest_keywords,
        return_type: type
      )
    end