Skip to content

Commit 0eb7765

Browse files
committed
Add docs for performance considerations
1 parent 9a9f4ca commit 0eb7765

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

src/structs.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@ impl CrcCalculator for Calculator {
4242
impl CrcParams {
4343
/// Creates custom CRC parameters for a given set of Rocksoft CRC parameters.
4444
///
45+
/// Generates the folding keys on-demand, which has a slight performance penalty. For
46+
/// performance-critical applications, consider generating the keys once and reusing them.
47+
///
4548
/// Does not support mis-matched refin/refout parameters, so both must be true or both false.
4649
///
4750
/// Rocksoft parameters for lots of variants: https://reveng.sourceforge.io/crc-catalogue/all.htm

0 commit comments

Comments
 (0)