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

# class RBS::Types::Record

### Attributes

all_fields[R]
fields[R]
location[R]
optional_fields[R]

### Public Class Methods

new(all_fields: nil, fields: nil, location:) click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 521
    def initialize(all_fields: nil, fields: nil, location:)
      case
      when fields && all_fields.nil?
        @all_fields = fields.transform_values { |v| [v, true] }
        @fields = fields
        @optional_fields = {}
      when all_fields && fields.nil?
        @all_fields = all_fields
        @fields = {}
        @optional_fields = {}
        all_fields.each do |(k, (v, required))|
          if required
            @fields[k] = v
          else
            @optional_fields[k] = v
          end
        end
      else
        raise ArgumentError, "only one of `:fields` or `:all_fields` is requireds"
      end

      @location = location
    end

### Public Instance Methods

==(other) click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 545
    def ==(other)
      other.is_a?(Record) && other.fields == fields && other.optional_fields == optional_fields
    end

Also aliased as: eql?
each_type(&block) click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 593
    def each_type(&block)
      if block
        fields.each_value(&block)
        optional_fields.each_value(&block)
      else
        enum_for :each_type
      end
    end

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

    # File rbs-3.8.0/lib/rbs/types.rb, line 555
    def free_variables(set = Set.new)
      set.tap do
        fields.each_value do |type|
          type.free_variables set
        end
        optional_fields.each_value do |type|
          type.free_variables set
        end
      end
    end

has_classish_type?() click to toggle source

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

has_self_type?() click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 620
    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 551
    def hash
      self.class.hash ^ all_fields.hash
    end

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

    # File rbs-3.8.0/lib/rbs/types.rb, line 609
    def map_type(&block)
      if block
        Record.new(
          all_fields: all_fields.transform_values {|type, required| [yield(type), required] },
          location: location
        )
      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 602
    def map_type_name(&block)
      Record.new(
        all_fields: all_fields.transform_values {|ty, required| [ty.map_type_name(&block), required] },
        location: location
      )
    end

sub(s) click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 570
    def sub(s)
      self.class.new(
        all_fields: all_fields.transform_values {|ty, required| [ty.sub(s), required] },
        location: location
      )
    end

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

    # File rbs-3.8.0/lib/rbs/types.rb, line 566
    def to_json(state = _ = nil)
      { class: :record, fields: fields, optional_fields: optional_fields, location: location }.to_json(state)
    end

to_s(level = 0) click to toggle source

    # File rbs-3.8.0/lib/rbs/types.rb, line 577
    def to_s(level = 0)
      return "{ }" if all_fields.empty?

      fields = all_fields.map do |key, (type, required)|
        field = if key.is_a?(Symbol) && key.match?(/\A[A-Za-z_][A-Za-z_0-9]*\z/)
          "#{key}: #{type}"
        else
          "#{key.inspect} => #{type}"
        end

        field = "?#{field}" unless required
        field
      end
      "{ #{fields.join(", ")} }"
    end

with_nonreturn_void?() click to toggle source

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