dreamworkAPI
Ctrl K
GitHub
classDocs / checksum / CRC32

checksum.CRC32

classsharedmenusource
Object → checksum.CRC8 → checksum.CRC16 → checksum.CRC32

The CRC-32 checksum calculation object.

Constructor

CRC32(poly: integer?, init: integer?, ref_in: boolean?, ref_out: boolean?, xor_out: integer?): checksum.CRC32

Fields

NameTypeDescription
DigestSizeintegerThe size of the checksum in bytes. = 4

Static functions

BZIP2The CRC-32 checksum class that uses BZIP2 algorithm parameters.
CThe CRC-32 checksum class that uses Castagnoli/C algorithm parameters.
DThe CRC-32 checksum class that uses D algorithm parameters.
digestCalculates the CRC-32 checksum of the specified string.
JAMCRCThe CRC-32 checksum class that uses JamCRC algorithm parameters.
MPEG2The CRC-32 checksum class that uses MPEG-2 algorithm parameters.
POSIXThe CRC-32 checksum class that uses POSIX algorithm parameters.
QThe CRC-32 checksum class that uses Q algorithm parameters.
XFERThe CRC-32 checksum class that uses XFER algorithm parameters.

#CRC32.BZIP2

sharedmenunodiscardsource
function CRC32.BZIP2(): checksum.CRC32

The CRC-32 checksum class that uses BZIP2 algorithm parameters.

Returns
TypeNameDescription
checksum.CRC32object

#CRC32.C

sharedmenunodiscardsource
function CRC32.C(): checksum.CRC32

The CRC-32 checksum class that uses Castagnoli/C algorithm parameters.

Returns
TypeNameDescription
checksum.CRC32object

#CRC32.D

sharedmenunodiscardsource
function CRC32.D(): checksum.CRC32

The CRC-32 checksum class that uses D algorithm parameters.

Returns
TypeNameDescription
checksum.CRC32object

#CRC32.digest

sharedmenunodiscardsource
function CRC32.digest(raw_str: string, poly?: integer, init?: integer, ref_in?: boolean, ref_out?: boolean, xor_out?: integer): integer

Calculates the CRC-32 checksum of the specified string.

Parameters
NameTypeDescription
raw_strstringThe string is used to calculate checksum.
polyoptionalintegerThe polynomial is used to calculate checksum.
initoptionalintegerThe initial value is used to calculate checksum.
ref_inoptionalbooleanWhether to reflect the input data before processing.
ref_outoptionalbooleanWhether to reflect the output data after processing.
xor_outoptionalintegerThe XOR value is used to calculate checksum.
Returns
TypeNameDescription
integerchecksumThe CRC-32 checksum, which is greater or equal to 0, and less than 2^32 (0x100000000).

#CRC32.JAMCRC

sharedmenunodiscardsource
function CRC32.JAMCRC(): checksum.CRC32

The CRC-32 checksum class that uses JamCRC algorithm parameters.

Returns
TypeNameDescription
checksum.CRC32object

#CRC32.MPEG2

sharedmenunodiscardsource
function CRC32.MPEG2(): checksum.CRC32

The CRC-32 checksum class that uses MPEG-2 algorithm parameters.

Returns
TypeNameDescription
checksum.CRC32object

#CRC32.POSIX

sharedmenunodiscardsource
function CRC32.POSIX(): checksum.CRC32

The CRC-32 checksum class that uses POSIX algorithm parameters.

Returns
TypeNameDescription
checksum.CRC32object

#CRC32.Q

sharedmenunodiscardsource
function CRC32.Q(): checksum.CRC32

The CRC-32 checksum class that uses Q algorithm parameters.

Returns
TypeNameDescription
checksum.CRC32object

#CRC32.XFER

sharedmenunodiscardsource
function CRC32.XFER(): checksum.CRC32

The CRC-32 checksum class that uses XFER algorithm parameters.

Returns
TypeNameDescription
checksum.CRC32object

Methods

digestFinalizes checksum calculation and returns the resulting checksum.
updateUpdates checksum with the specified string.

#CRC32:digest

sharedmenunodiscardsource
function checksum.CRC32:digest(): integer

Finalizes checksum calculation and returns the resulting checksum.

Returns
TypeNameDescription
integerchecksumThe final checksum value, which is greater or equal to 0, and less than 2^32 (0x100000000).

#CRC32:update

sharedmenusource
function checksum.CRC32:update(raw_str: string): checksum.CRC32

Updates checksum with the specified string.

Parameters
NameTypeDescription
raw_strstringThe string is used to update checksum.
Returns
TypeNameDescription
checksum.CRC32self

Inherited methods

From checksum.CRC8 1
Generated from the dreamwork meta branch.