module Net::IMAP::NumValidator - RDoc Documentation

# module Net::IMAP::NumValidator

Common validators of number and nz_number types

### Public Class Methods

ensure_mod_sequence_value(num) click to toggle source

Ensure argument is 'mod_sequence_value' or raise `DataFormatError`

    # File lib/net/imap.rb, line 1708
    def ensure_mod_sequence_value(num)
      return if valid_mod_sequence_value?(num)

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

ensure_number(num) click to toggle source

Ensure argument is 'number' or raise `DataFormatError`

    # File lib/net/imap.rb, line 1692
    def ensure_number(num)
      return if valid_number?(num)

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

ensure_nz_number(num) click to toggle source

Ensure argument is 'nz_number' or raise `DataFormatError`

    # File lib/net/imap.rb, line 1700
    def ensure_nz_number(num)
      return 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) click to toggle source

Check is passed argument valid 'mod_sequence_value' in RFC 4551 terminology

    # File lib/net/imap.rb, line 1683
    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) click to toggle source

Check is passed argument valid 'number' in RFC 3501 terminology

    # File lib/net/imap.rb, line 1665
    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) click to toggle source

Check is passed argument valid 'nz_number' in RFC 3501 terminology

    # File lib/net/imap.rb, line 1674
    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