Support BigInt conversion in HashDigest

- Renames `remainder` -> `number`
- Adds `bigInt` method to get BigInt from bytes

Author: dipu-bd

CHANGELOG.md

@@ -1,6 +1,9 @@
 # 1.11.4
 
 - Move codecs to separate package: [hashlib_codecs](https://github.com/bitanon/hashlib_codecs)
+- Support BigInt conversion in `HashDigest`
+  - Renames `remainder` -> `number`
+  - Adds `bigInt` method to get `BigInt` from bytes
 
 # 1.11.3
 

lib/src/alder32.dart

@@ -37,5 +37,5 @@ class _Alder32 extends HashBase {
 /// - [input] is the string to hash
 /// - The [encoding] is the encoding to use. Default is `input.codeUnits`
 int alder32code(String input, [Encoding? encoding]) {
-  return alder32.string(input, encoding).remainder();
+  return alder32.string(input, encoding).number();
 }

lib/src/core/hash_digest.dart

@@ -41,6 +41,22 @@ class HashDigest extends Object {
   String base64({bool urlSafe = false, bool padding = false}) =>
       toBase64(bytes, padding: padding, url: urlSafe);
 
+  /// The message digest as a BigInt.
+  ///
+  /// If [endian] is [Endian.little], it will treat the digest bytes as a little
+  /// endian number; Otherwise, if [endian] is [Endian.big], it will treat the
+  /// digest bytes as a big endian number.
+  BigInt bigInt({Endian endian = Endian.little}) =>
+      toBigInt(bytes, endian: endian);
+
+  /// Gets 64-bit unsiged integer from the message digest.
+  ///
+  /// If [endian] is [Endian.little], it will treat the digest bytes as a little
+  /// endian number; Otherwise, if [endian] is [Endian.big], it will treat the
+  /// digest bytes as a big endian number.
+  int number([Endian endian = Endian.big]) =>
+      toBigInt(bytes, endian: endian).toUnsigned(64).toInt();
+
   /// The message digest as a string of ASCII alphabets.
   String ascii() => cvt.ascii.decode(bytes);
 
@@ -50,25 +66,6 @@ class HashDigest extends Object {
   /// Returns the digest in the given [encoding]
   String to(cvt.Encoding encoding) => encoding.decode(bytes);
 
-  /// Returns the least significant bytes as a number.
-  ///
-  /// If [endian] is big, it will return the last few bytes as a number;
-  /// Otherwise, if [endian] is little, it will return the first few bytes
-  /// as a number.
-  int remainder([Endian endian = Endian.big]) {
-    int result = 0;
-    if (endian == Endian.big) {
-      for (int i = bytes.length - 1, p = 0; i >= 0; --i, p += 8) {
-        result |= bytes[i] << p;
-      }
-    } else {
-      for (int i = 0, p = 0; i < 8 && i < bytes.length; ++i, p += 8) {
-        result |= bytes[i] << p;
-      }
-    }
-    return result;
-  }
-
   @override
   int get hashCode => bytes.hashCode;
 

lib/src/crc16.dart

@@ -28,5 +28,5 @@ class _CRC16 extends HashBase {
 /// - [input] is the string to hash
 /// - The [encoding] is the encoding to use. Default is `input.codeUnits`
 int crc16code(String input, [Encoding? encoding]) {
-  return crc16.string(input, encoding).remainder();
+  return crc16.string(input, encoding).number();
 }

lib/src/crc32.dart

@@ -30,7 +30,7 @@ class _CRC32 extends HashBase {
 /// - [input] is the string to hash
 /// - The [encoding] is the encoding to use. Default is `input.codeUnits`
 int crc32code(String input, [Encoding? encoding]) {
-  return crc32.string(input, encoding).remainder();
+  return crc32.string(input, encoding).number();
 }
 
 /// Extension to [String] to generate [crc32] code
@@ -40,6 +40,6 @@ extension CRC32StringExtension on String {
   /// Parameters:
   /// - If no [encoding] is defined, the `codeUnits` is used to get the bytes.
   int crc32code([Encoding? encoding]) {
-    return crc32.string(this, encoding).remainder();
+    return crc32.string(this, encoding).number();
   }
 }

lib/src/crc64.dart

@@ -30,7 +30,7 @@ class _CRC64 extends HashBase {
 /// - [input] is the string to hash
 /// - The [encoding] is the encoding to use. Default is `input.codeUnits`
 int crc64code(String input, [Encoding? encoding]) {
-  return crc64.string(input, encoding).remainder();
+  return crc64.string(input, encoding).number();
 }
 
 /// Gets the CRC-64 hash of a String in hexadecimal.

lib/src/xxh3.dart

@@ -59,7 +59,7 @@ class XXH3 extends BlockHashBase {
 /// - [input] is the string to hash
 /// - The [encoding] is the encoding to use. Default is `input.codeUnits`
 int xxh3code(String input, [Encoding? encoding]) {
-  return xxh3.string(input, encoding).remainder();
+  return xxh3.string(input, encoding).number();
 }
 
 /// Gets the 64-bit XXH3 hash of a String in hexadecimal.
@@ -78,7 +78,7 @@ extension XXH3StringExtension on String {
   /// Parameters:
   /// - If no [encoding] is defined, the `codeUnits` is used to get the bytes.
   int xxh3code([Encoding? encoding]) {
-    return xxh3.string(this, encoding).remainder();
+    return xxh3.string(this, encoding).number();
   }
 
   /// Gets the 64-bit XXH3 hash of a String in hexadecimal.

lib/src/xxh32.dart

@@ -45,7 +45,7 @@ class XXHash32 extends BlockHashBase {
 /// - [input] is the string to hash
 /// - The [encoding] is the encoding to use. Default is `input.codeUnits`
 int xxh32code(String input, [Encoding? encoding]) {
-  return xxh32.string(input, encoding).remainder();
+  return xxh32.string(input, encoding).number();
 }
 
 /// Extension to [String] to generate [xxh32] code
@@ -55,6 +55,6 @@ extension XXHash32StringExtension on String {
   /// Parameters:
   /// - If no [encoding] is defined, the `codeUnits` is used to get the bytes.
   int xxh32code([Encoding? encoding]) {
-    return xxh32.string(this, encoding).remainder();
+    return xxh32.string(this, encoding).number();
   }
 }

lib/src/xxh64.dart

@@ -45,7 +45,7 @@ class XXHash64 extends BlockHashBase {
 /// - [input] is the string to hash.
 /// - The [encoding] is the encoding to use. Default is `input.codeUnits`.
 int xxh64code(String input, [Encoding? encoding]) {
-  return xxh64.string(input, encoding).remainder();
+  return xxh64.string(input, encoding).number();
 }
 
 /// Gets the 64-bit xxHash hash of a String in hexadecimal.
@@ -64,7 +64,7 @@ extension XXHash64StringExtension on String {
   /// Parameters:
   /// - If no [encoding] is defined, the `codeUnits` is used to get the bytes.
   int xxh64code([Encoding? encoding]) {
-    return xxh64.string(this, encoding).remainder();
+    return xxh64.string(this, encoding).number();
   }
 
   /// Gets the 64-bit xxHash hash of a String in hexadecimal.

pubspec.yaml

@@ -15,7 +15,7 @@ platforms:
   windows:
 
 dependencies:
-  hashlib_codecs: ^1.1.1
+  hashlib_codecs: ^1.2.0
 
 dev_dependencies:
   lints: ^1.0.1

test/crc_test.dart

@@ -11,13 +11,15 @@ void main() {
     });
     test('CRC-16 with a string', () {
       expect(crc16.string("Wikipedia").hex(), "ee3e");
+      expect(crc16code("Wikipedia"), 0xee3e);
     });
 
     test('CRC-32 with empty string', () {
       expect(crc32code(""), 0);
     });
     test('CRC-32 with a string', () {
       expect(crc32.string("Wikipedia").hex(), "adaac02e");
+      expect(crc32code("Wikipedia"), 0xadaac02e);
     });
 
     test('CRC-64 with empty string', () {