Module: Net::IMAP::NumValidator
- Defined in:
- lib/net/imap/data_encoding.rb
Overview
Common validators of number and nz_number types
Class Method Summary collapse
-
.ensure_mod_sequence_value(num) ⇒ Object
Ensure argument is ‘mod_sequence_value’ or raise DataFormatError.
-
.ensure_number(num) ⇒ Object
Ensure argument is ‘number’ or raise DataFormatError.
-
.ensure_nz_number(num) ⇒ Object
Ensure argument is ‘nz_number’ or raise DataFormatError.
-
.valid_mod_sequence_value?(num) ⇒ Boolean
Check is passed argument valid ‘mod_sequence_value’ in RFC 4551 terminology.
-
.valid_number?(num) ⇒ Boolean
Check is passed argument valid ‘number’ in RFC 3501 terminology.
-
.valid_nz_number?(num) ⇒ Boolean
Check is passed argument valid ‘nz_number’ in RFC 3501 terminology.
Class Method Details
.ensure_mod_sequence_value(num) ⇒ Object
Ensure argument is ‘mod_sequence_value’ or raise DataFormatError
192 193 194 195 196 197 |
# File 'lib/net/imap/data_encoding.rb', line 192 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) ⇒ Object
Ensure argument is ‘number’ or raise DataFormatError
176 177 178 179 180 181 |
# File 'lib/net/imap/data_encoding.rb', line 176 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) ⇒ Object
Ensure argument is ‘nz_number’ or raise DataFormatError
184 185 186 187 188 189 |
# File 'lib/net/imap/data_encoding.rb', line 184 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) ⇒ Boolean
Check is passed argument valid ‘mod_sequence_value’ in RFC 4551 terminology
167 168 169 170 171 172 173 |
# File 'lib/net/imap/data_encoding.rb', line 167 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
Check is passed argument valid ‘number’ in RFC 3501 terminology
149 150 151 152 153 154 155 |
# File 'lib/net/imap/data_encoding.rb', line 149 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
Check is passed argument valid ‘nz_number’ in RFC 3501 terminology
158 159 160 161 162 163 164 |
# File 'lib/net/imap/data_encoding.rb', line 158 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 |