123456789_123456789_123456789_123456789_123456789_

Module: Net::IMAP::NumValidator

Relationships & Source Files
Defined in: lib/net/imap/data_encoding.rb

Overview

Common validators of number and nz_number types

Class Method Summary

Class Method Details

.ensure_mod_sequence_value(num) (mod_func)

Ensure argument is ‘mod_sequence_value’ or raise DataFormatError

Raises:

[ GitHub ] 

  


# File 'lib/net/imap/data_encoding.rb', line 204



def ensure_mod_sequence_value(num)
  return num if valid_mod_sequence_value?(num)

  msg = "mod_sequence_value must be unsigned 64-bit integer: #{num}"
  raise DataFormatError, msg
end


  








  

    .ensure_number(num)   (mod_func)
  



  

    

Ensure argument is ‘number’ or raise DataFormatError


  





  
Raises:





  [ GitHub ]


  

  


# File 'lib/net/imap/data_encoding.rb', line 188



def ensure_number(num)
  return num if valid_number?(num)

  msg = "number must be unsigned 32-bit integer: #{num}"
  raise DataFormatError, msg
end


  








  

    .ensure_nz_number(num)   (mod_func)
  



  

    

Ensure argument is ‘nz_number’ or raise DataFormatError


  





  
Raises:





  [ GitHub ]


  

  


# File 'lib/net/imap/data_encoding.rb', line 196



def ensure_nz_number(num)
  return num if valid_nz_number?(num)

  msg = "nz_number must be non-zero unsigned 32-bit integer: #{num}"
  raise DataFormatError, msg
end


  








  

    .valid_mod_sequence_value?(num)  ⇒ Boolean  (mod_func)
  



  

    

Check is passed argument valid ‘mod_sequence_value’ in RFC 4551 terminology


  





  


  [ GitHub ]


  

  


# File 'lib/net/imap/data_encoding.rb', line 179



def valid_mod_sequence_value?(num)
  # mod-sequence-value  = 1*DIGIT
  #                        ; Positive unsigned 64-bit integer
  #                        ; (mod-sequence)
  #                        ; (1 <= n < 18,446,744,073,709,551,615)
  num >= 1 && num < 18446744073709551615
end


  








  

    .valid_number?(num)  ⇒ Boolean  (mod_func)
  



  

    

Check is passed argument valid ‘number’ in RFC 3501 terminology


  





  


  [ GitHub ]


  

  


# File 'lib/net/imap/data_encoding.rb', line 161



def valid_number?(num)
  # [RFC 3501]
  # number          = 1*DIGIT
  #                    ; Unsigned 32-bit integer
  #                    ; (0 <= n < 4,294,967,296)
  num >= 0 && num < 4294967296
end


  








  

    .valid_nz_number?(num)  ⇒ Boolean  (mod_func)
  



  

    

Check is passed argument valid ‘nz_number’ in RFC 3501 terminology


  





  


  [ GitHub ]


  

  


# File 'lib/net/imap/data_encoding.rb', line 170



def valid_nz_number?(num)
  # [RFC 3501]
  # nz-number       = digit-nz *DIGIT
  #                    ; Non-zero unsigned 32-bit integer
  #                    ; (0 < n < 4,294,967,296)
  num != 0 && valid_number?(num)
end