1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
# Digest CRC
* [Source](https://github.com/postmodern/digest-crc)
* [Issues](https://github.com/postmodern/digest-crc/issues)
* [Documentation](http://rubydoc.info/gems/digest-crc/frames)
* [Email](mailto:postmodern.mod3 at gmail.com)
## Description
Adds support for calculating Cyclic Redundancy Check (CRC) to the Digest
module.
## Features
* Provides support for the following CRC algorithms:
* {Digest::CRC1 CRC1}
* {Digest::CRC5 CRC5}
* {Digest::CRC8 CRC8}
* {Digest::CRC81Wire CRC8 1-Wire}
* {Digest::CRC16 CRC16}
* {Digest::CRC16CCITT CRC16 CCITT}
* {Digest::CRC16DNP CRC16 DNP}
* {Digest::CRC16Modbus CRC16 Modbus}
* {Digest::CRC16USB CRC16 USB}
* {Digest::CRC16XModem CRC16 XModem}
* {Digest::CRC16ZModem CRC16 ZModem}
* {Digest::CRC16QT CRC16 QT}
* {Digest::CRC24 CRC24}
* {Digest::CRC32 CRC32}
* {Digest::CRC32c CRC32c}
* {Digest::CRC32Mpeg CRC32 Mpeg}
* {Digest::CRC64 CRC64}
* Pure Ruby implementation.
* Provides CRC Tables for optimized calculations.
## Install
$ gem install digest-crc
## Examples
Calculate a CRC32:
require 'digest/crc32'
Digest::CRC32.hexdigest('hello')
# => "3610a686"
Calculate a CRC32 of a file:
Digest::CRC32.file('README.md')
# => #<Digest::CRC32: 127ad531>
Incrementally calculate a CRC32:
crc = Digest::CRC32.new
crc << 'one'
crc << 'two'
crc << 'three'
crc.hexdigest
# => "09e1c092"
Directly access the checksum:
crc.checksum
# => 165789842
## Thanks
Special thanks go out to the [pycrc](http://www.tty1.net/pycrc/) library
which is able to generate C source-code for all of the CRC algorithms,
including their CRC Tables.
## License
Copyright (c) 2010-2013 Hal Brodigan
See {file:LICENSE.txt} for license information.
|
