123456789_123456789_123456789_123456789_123456789_

Module: Net::IMAP::Config::AttrAccessors

Relationships & Source Files
Namespace Children
Modules:
Macros
Extension / Inclusion / Inheritance Descendants
Included In:
::Net::IMAP::Config
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Forwardable
Defined in: lib/net/imap/config/attr_accessors.rb

Overview

NOTE: This module is an internal implementation detail, with no guarantee of backward compatibility.

.attr_accessor values are stored in a struct rather than ivars, making it simpler to ensure that all config objects share a single object shape. This also simplifies iteration over all defined attributes.

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Class Method Details

.attr_accessor(name)

This method is for internal use only.

internal API

Raises:

  • (ArgumentError)
[ GitHub ] 

  


# File 'lib/net/imap/config/attr_accessors.rb', line 28



def self.attr_accessor(name) # :nodoc: internal API
  name = name.to_sym
  raise ArgumentError, "already defined #{name}" if attributes.include?(name)
  attributes << name
  def_delegators :data, name, :"#{name}="
end


  








  

    .included(mod)   (private)
  

  [ GitHub ]


  

  


# File 'lib/net/imap/config/attr_accessors.rb', line 21



def self.included(mod)
  mod.extend Macros
end


  








  

    .struct  
  

  

    This method is for internal use only.
  



  

    

internal API


  



  [ GitHub ]


  

  


# File 'lib/net/imap/config/attr_accessors.rb', line 39



def self.struct # :nodoc: internal API
  attributes.freeze
  Struct.new(*attributes)
end


  







Instance Attribute Details



  

    #attributes   (readonly)
  



  

    

An array of ::Net::IMAP::Config attribute names


  



  [ GitHub ]


  

  


# File 'lib/net/imap/config/attr_accessors.rb', line 36



singleton_class.attr_reader :attributes


  








  

    #data   (readonly, protected)
  

  

    This method is for internal use only.
  



  

    

internal API


  



  [ GitHub ]


  

  


# File 'lib/net/imap/config/attr_accessors.rb', line 57



attr_reader :data # :nodoc: internal API


  







Instance Method Details



  

    #freeze  
  



  

    

Freezes the internal attributes struct, in addition to self.


  



  [ GitHub ]


  

  


# File 'lib/net/imap/config/attr_accessors.rb', line 50



def freeze
  data.freeze
  super
end


  








  

    #initialize  
  



  

    

:notnew:


  



  [ GitHub ]


  

  


# File 'lib/net/imap/config/attr_accessors.rb', line 44



def initialize # :notnew:
  super()
  @data = Config::Struct.new
end


  








  

    #initialize_clone(other)   (private)
  

  [ GitHub ]


  

  


# File 'lib/net/imap/config/attr_accessors.rb', line 61



def initialize_clone(other)
  super
  @data = other.data.clone
end


  








  

    #initialize_dup(other)   (private)
  

  [ GitHub ]


  

  


# File 'lib/net/imap/config/attr_accessors.rb', line 66



def initialize_dup(other)
  super
  @data = other.data.dup
end