Make CrcParams public

Enables easier integration for consumers who would like to use custom
CRC parameters, such as polynomials.

Author: onethumb

src/algorithm.rs

@@ -17,9 +17,9 @@
 
 use crate::consts::CRC_CHUNK_SIZE;
 use crate::enums::{DataChunkProcessor, Reflector};
-use crate::structs::{CrcParams, CrcState};
+use crate::structs::CrcState;
 use crate::traits::{ArchOps, EnhancedCrcWidth};
-use crate::{crc32, crc64};
+use crate::{crc32, crc64, CrcParams};
 
 /// Main entry point that works for both CRC-32 and CRC-64
 #[inline]

src/arch/mod.rs

@@ -11,7 +11,7 @@ use std::arch::is_aarch64_feature_detected;
 #[cfg(any(target_arch = "x86", target_arch = "x86_64", target_arch = "aarch64"))]
 use crate::algorithm;
 
-use crate::structs::CrcParams;
+use crate::CrcParams;
 
 #[cfg(any(target_arch = "x86", target_arch = "x86_64", target_arch = "aarch64"))]
 use crate::structs::{Width32, Width64};

src/arch/software.rs

@@ -5,8 +5,8 @@
 #![cfg(not(any(target_arch = "x86", target_arch = "x86_64", target_arch = "aarch64")))]
 
 use crate::consts::CRC_64_NVME;
-use crate::structs::CrcParams;
 use crate::CrcAlgorithm;
+use crate::CrcParams;
 use crc::Table;
 
 const RUST_CRC32_AIXM: crc::Crc<u32, Table<16>> =

src/combine.rs

@@ -50,7 +50,7 @@
      http://reveng.sourceforge.net/crc-catalogue/all.htm
 */
 
-use crate::structs::CrcParams;
+use crate::CrcParams;
 
 /* Multiply the GF(2) vector vec by the GF(2) matrix mat, returning the
 resulting vector.  The vector is stored as bits in a crc_t.  The matrix is

src/crc32/consts.rs

@@ -7,8 +7,8 @@ use crate::consts::{
     NAME_CRC32_CD_ROM_EDC, NAME_CRC32_CKSUM, NAME_CRC32_ISCSI, NAME_CRC32_ISO_HDLC,
     NAME_CRC32_JAMCRC, NAME_CRC32_MEF, NAME_CRC32_MPEG_2, NAME_CRC32_XFER,
 };
-use crate::structs::CrcParams;
 use crate::CrcAlgorithm;
+use crate::CrcParams;
 use crc::{
     CRC_32_AIXM, CRC_32_AUTOSAR, CRC_32_BASE91_D, CRC_32_BZIP2, CRC_32_CD_ROM_EDC, CRC_32_CKSUM,
     CRC_32_ISCSI, CRC_32_ISO_HDLC, CRC_32_JAMCRC, CRC_32_MEF, CRC_32_MPEG_2, CRC_32_XFER,

src/crc64/consts.rs

@@ -3,8 +3,8 @@
 #![allow(dead_code)]
 
 use crate::consts::*;
-use crate::structs::CrcParams;
 use crate::CrcAlgorithm;
+use crate::CrcParams;
 use crc::{CRC_64_ECMA_182, CRC_64_GO_ISO, CRC_64_MS, CRC_64_REDIS, CRC_64_WE, CRC_64_XZ};
 
 // width=64 poly=0x42f0e1eba9ea3693 init=0x0000000000000000 refin=false refout=false xorout=0x0000000000000000 check=0x6c40df5f0b497347 residue=0x0000000000000000 name="CRC-64/ECMA-182"

src/ffi.rs

@@ -7,8 +7,8 @@
 
 #![cfg(any(target_arch = "aarch64", target_arch = "x86_64", target_arch = "x86"))]
 
-use crate::structs::CrcParams;
 use crate::CrcAlgorithm;
+use crate::CrcParams;
 use crate::{get_calculator_target, Digest};
 use std::ffi::CStr;
 use std::os::raw::c_char;

src/lib.rs

@@ -116,7 +116,7 @@ use crate::crc32::fusion;
 use crate::crc64::consts::{
     CRC64_ECMA_182, CRC64_GO_ISO, CRC64_MS, CRC64_NVME, CRC64_REDIS, CRC64_WE, CRC64_XZ,
 };
-use crate::structs::{Calculator, CrcParams};
+use crate::structs::Calculator;
 use crate::traits::CrcCalculator;
 use digest::{DynDigest, InvalidBufferSize};
 use std::fs::File;
@@ -161,6 +161,21 @@ pub enum CrcAlgorithm {
     Crc64Xz,
 }
 
+/// Parameters for CRC computation, including polynomial, initial value, and other settings.
+#[derive(Clone, Copy, Debug)]
+pub struct CrcParams {
+    pub algorithm: CrcAlgorithm,
+    pub name: &'static str,
+    pub width: u8,
+    pub poly: u64,
+    pub init: u64,
+    pub refin: bool,
+    pub refout: bool,
+    pub xorout: u64,
+    pub check: u64,
+    pub keys: [u64; 23],
+}
+
 /// Type alias for a function pointer that represents a CRC calculation function.
 ///
 /// The function takes the following parameters:
@@ -493,9 +508,9 @@ pub fn checksum_combine_with_custom_params(
 }
 
 /// Returns the custom CRC parameters for a given set of Rocksoft CRC parameters.
-/// 
+///
 /// Does not support mis-matched refin/refout parameters, so both must be true or both false.
-/// 
+///
 /// Rocksoft parameters for lots of variants: https://reveng.sourceforge.io/crc-catalogue/all.htm
 pub fn get_custom_params(
     name: &'static str,
@@ -614,8 +629,7 @@ mod lib {
     use super::*;
     use crate::test::consts::{TEST_ALL_CONFIGS, TEST_CHECK_STRING};
     use crate::test::enums::AnyCrcTestConfig;
-    use crate::CrcAlgorithm::Crc32Iscsi;
-    use cbindgen::Language::{Cxx, C};
+    use cbindgen::Language::C;
     use cbindgen::Style::Both;
     use rand::{rng, Rng};
     use std::fs::{read, write};

src/structs.rs

@@ -2,24 +2,8 @@
 
 #![allow(dead_code)]
 
-use crate::arch;
 use crate::traits::{CrcCalculator, CrcWidth};
-use crate::CrcAlgorithm;
-
-#[derive(Clone, Copy, Debug)]
-pub struct CrcParams {
-    pub algorithm: CrcAlgorithm,
-    pub name: &'static str,
-    pub width: u8,
-    pub poly: u64,
-    pub init: u64,
-    pub refin: bool,
-    pub refout: bool,
-    pub xorout: u64,
-    pub check: u64,
-    pub keys: [u64; 23],
-}
-
+use crate::{arch, CrcParams};
 /// CRC-32 width implementation
 #[derive(Clone, Copy)]
 pub struct Width32;

src/test/enums.rs

@@ -3,9 +3,9 @@
 #![cfg(test)]
 #![allow(dead_code)]
 
-use crate::structs::CrcParams;
 use crate::test::structs::*;
 use crate::CrcAlgorithm;
+use crate::CrcParams;
 use crc::Crc;
 
 pub enum AnyCrcTestConfig {

src/test/structs.rs

@@ -3,7 +3,7 @@
 #![cfg(test)]
 #![allow(dead_code)]
 
-use crate::structs::CrcParams;
+use crate::CrcParams;
 use crc::{Crc, Table};
 
 pub struct CrcTestConfig<T: crc::Width, I: crc::Implementation + 'static> {

src/traits.rs

@@ -5,7 +5,7 @@
 #[cfg(any(target_arch = "x86", target_arch = "x86_64", target_arch = "aarch64"))]
 use crate::enums::Reflector;
 
-use crate::structs::CrcParams;
+use crate::CrcParams;
 
 #[cfg(any(target_arch = "x86", target_arch = "x86_64", target_arch = "aarch64"))]
 use crate::structs::CrcState;