Collaboration diagram for Public API:

Modules
	XXH32 family

	XXH64 family

Macros
#define	XXH_versionNumber(void) XXH_NAME2(XXH_NAMESPACE, XXH_versionNumber)
	Obtains the xxHash version. More...

#define	XXHASH_H_5627135585666179 1

#define	XXH_PUBLIC_API /* do nothing */
	Marks a global symbol. More...

#define	XXH_PUBLIC_API /* do nothing */
	Marks a global symbol. More...

#define	XXH_CAT(A, B) A##B

#define	XXH_NAME2(A, B) XXH_CAT(A,B)

#define	XXH32 XXH_NAME2(XXH_NAMESPACE, XXH32)

#define	XXH32_freeState XXH_NAME2(XXH_NAMESPACE, XXH32_freeState)

#define	XXH32_reset XXH_NAME2(XXH_NAMESPACE, XXH32_reset)

#define	XXH32_update XXH_NAME2(XXH_NAMESPACE, XXH32_update)

#define	XXH32_digest XXH_NAME2(XXH_NAMESPACE, XXH32_digest)

#define	XXH32_copyState XXH_NAME2(XXH_NAMESPACE, XXH32_copyState)

#define	XXH32_canonicalFromHash XXH_NAME2(XXH_NAMESPACE, XXH32_canonicalFromHash)

#define	XXH32_hashFromCanonical XXH_NAME2(XXH_NAMESPACE, XXH32_hashFromCanonical)

#define	XXH64 XXH_NAME2(XXH_NAMESPACE, XXH64)

#define	XXH64_freeState XXH_NAME2(XXH_NAMESPACE, XXH64_freeState)

#define	XXH64_reset XXH_NAME2(XXH_NAMESPACE, XXH64_reset)

#define	XXH64_update XXH_NAME2(XXH_NAMESPACE, XXH64_update)

#define	XXH64_digest XXH_NAME2(XXH_NAMESPACE, XXH64_digest)

#define	XXH64_copyState XXH_NAME2(XXH_NAMESPACE, XXH64_copyState)

#define	XXH64_canonicalFromHash XXH_NAME2(XXH_NAMESPACE, XXH64_canonicalFromHash)

#define	XXH64_hashFromCanonical XXH_NAME2(XXH_NAMESPACE, XXH64_hashFromCanonical)

#define	XXH3_64bits XXH_NAME2(XXH_NAMESPACE, XXH3_64bits)

#define	XXH3_64bits_withSecret XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_withSecret)

#define	XXH3_64bits_withSeed XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_withSeed)

#define	XXH3_64bits_withSecretandSeed XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_withSecretandSeed)

#define	XXH3_createState XXH_NAME2(XXH_NAMESPACE, XXH3_createState)

#define	XXH3_freeState XXH_NAME2(XXH_NAMESPACE, XXH3_freeState)

#define	XXH3_copyState XXH_NAME2(XXH_NAMESPACE, XXH3_copyState)

#define	XXH3_64bits_reset XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_reset)

#define	XXH3_64bits_reset_withSeed XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_reset_withSeed)

#define	XXH3_64bits_reset_withSecret XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_reset_withSecret)

#define	XXH3_64bits_reset_withSecretandSeed XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_reset_withSecretandSeed)

#define	XXH3_64bits_update XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_update)

#define	XXH3_64bits_digest XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_digest)

#define	XXH3_generateSecret XXH_NAME2(XXH_NAMESPACE, XXH3_generateSecret)

#define	XXH3_generateSecret_fromSeed XXH_NAME2(XXH_NAMESPACE, XXH3_generateSecret_fromSeed)

#define	XXH128 XXH_NAME2(XXH_NAMESPACE, XXH128)

#define	XXH3_128bits XXH_NAME2(XXH_NAMESPACE, XXH3_128bits)

#define	XXH3_128bits_withSeed XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_withSeed)

#define	XXH3_128bits_withSecret XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_withSecret)

#define	XXH3_128bits_withSecretandSeed XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_withSecretandSeed)

#define	XXH3_128bits_reset XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_reset)

#define	XXH3_128bits_reset_withSeed XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_reset_withSeed)

#define	XXH3_128bits_reset_withSecret XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_reset_withSecret)

#define	XXH3_128bits_reset_withSecretandSeed XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_reset_withSecretandSeed)

#define	XXH3_128bits_update XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_update)

#define	XXH3_128bits_digest XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_digest)

#define	XXH128_isEqual XXH_NAME2(XXH_NAMESPACE, XXH128_isEqual)

#define	XXH128_cmp XXH_NAME2(XXH_NAMESPACE, XXH128_cmp)

#define	XXH128_canonicalFromHash XXH_NAME2(XXH_NAMESPACE, XXH128_canonicalFromHash)

#define	XXH128_hashFromCanonical XXH_NAME2(XXH_NAMESPACE, XXH128_hashFromCanonical)

#define	XXH_CONSTF /* disable */

#define	XXH_PUREF

#define	XXH_MALLOCF

#define	XXH_VERSION_MAJOR 0

#define	XXH_VERSION_MINOR 8

#define	XXH_VERSION_RELEASE 2

#define	XXH_VERSION_NUMBER (XXH_VERSION_MAJOR 100100 + XXH_VERSION_MINOR *100 + XXH_VERSION_RELEASE)
	Version number, encoded as two digits each. More...

Enumerations
enum	XXH_errorcode { XXH_OK = 0 , XXH_ERROR }
	Exit code for the streaming API. More...

typedef unsigned long long	XXH64_hash_t

Detailed Description

Contains details on the public xxHash functions.

Macro Definition Documentation

◆ XXH128

#define XXH128 XXH_NAME2(XXH_NAMESPACE, XXH128)

Definition at line 486 of file xxhash.h.

◆ XXH128_canonicalFromHash

#define XXH128_canonicalFromHash XXH_NAME2(XXH_NAMESPACE, XXH128_canonicalFromHash)

Definition at line 499 of file xxhash.h.

◆ XXH128_cmp

#define XXH128_cmp XXH_NAME2(XXH_NAMESPACE, XXH128_cmp)

Definition at line 498 of file xxhash.h.

◆ XXH128_hashFromCanonical

#define XXH128_hashFromCanonical XXH_NAME2(XXH_NAMESPACE, XXH128_hashFromCanonical)

Definition at line 500 of file xxhash.h.

◆ XXH128_isEqual

#define XXH128_isEqual XXH_NAME2(XXH_NAMESPACE, XXH128_isEqual)

Definition at line 497 of file xxhash.h.

◆ XXH32

#define XXH32 XXH_NAME2(XXH_NAMESPACE, XXH32)

Definition at line 450 of file xxhash.h.

◆ XXH32_canonicalFromHash

#define XXH32_canonicalFromHash XXH_NAME2(XXH_NAMESPACE, XXH32_canonicalFromHash)

Definition at line 457 of file xxhash.h.

◆ XXH32_copyState

#define XXH32_copyState XXH_NAME2(XXH_NAMESPACE, XXH32_copyState)

Definition at line 456 of file xxhash.h.

◆ XXH32_digest

#define XXH32_digest XXH_NAME2(XXH_NAMESPACE, XXH32_digest)

Definition at line 455 of file xxhash.h.

◆ XXH32_freeState

#define XXH32_freeState XXH_NAME2(XXH_NAMESPACE, XXH32_freeState)

Definition at line 452 of file xxhash.h.

◆ XXH32_hashFromCanonical

#define XXH32_hashFromCanonical XXH_NAME2(XXH_NAMESPACE, XXH32_hashFromCanonical)

Definition at line 458 of file xxhash.h.

◆ XXH32_reset

#define XXH32_reset XXH_NAME2(XXH_NAMESPACE, XXH32_reset)

Definition at line 453 of file xxhash.h.

◆ XXH32_update

#define XXH32_update XXH_NAME2(XXH_NAMESPACE, XXH32_update)

Definition at line 454 of file xxhash.h.

◆ XXH3_128bits

#define XXH3_128bits XXH_NAME2(XXH_NAMESPACE, XXH3_128bits)

Definition at line 487 of file xxhash.h.

◆ XXH3_128bits_digest

#define XXH3_128bits_digest XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_digest)

Definition at line 496 of file xxhash.h.

◆ XXH3_128bits_reset

#define XXH3_128bits_reset XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_reset)

Definition at line 491 of file xxhash.h.

◆ XXH3_128bits_reset_withSecret

#define XXH3_128bits_reset_withSecret XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_reset_withSecret)

Definition at line 493 of file xxhash.h.

◆ XXH3_128bits_reset_withSecretandSeed

#define XXH3_128bits_reset_withSecretandSeed XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_reset_withSecretandSeed)

Definition at line 494 of file xxhash.h.

◆ XXH3_128bits_reset_withSeed

#define XXH3_128bits_reset_withSeed XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_reset_withSeed)

Definition at line 492 of file xxhash.h.

◆ XXH3_128bits_update

#define XXH3_128bits_update XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_update)

Definition at line 495 of file xxhash.h.

◆ XXH3_128bits_withSecret

#define XXH3_128bits_withSecret XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_withSecret)

Definition at line 489 of file xxhash.h.

◆ XXH3_128bits_withSecretandSeed

#define XXH3_128bits_withSecretandSeed XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_withSecretandSeed)

Definition at line 490 of file xxhash.h.

◆ XXH3_128bits_withSeed

#define XXH3_128bits_withSeed XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_withSeed)

Definition at line 488 of file xxhash.h.

◆ XXH3_64bits

#define XXH3_64bits XXH_NAME2(XXH_NAMESPACE, XXH3_64bits)

Definition at line 470 of file xxhash.h.

◆ XXH3_64bits_digest

#define XXH3_64bits_digest XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_digest)

Definition at line 482 of file xxhash.h.

◆ XXH3_64bits_reset

#define XXH3_64bits_reset XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_reset)

Definition at line 477 of file xxhash.h.

◆ XXH3_64bits_reset_withSecret

#define XXH3_64bits_reset_withSecret XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_reset_withSecret)

Definition at line 479 of file xxhash.h.

◆ XXH3_64bits_reset_withSecretandSeed

#define XXH3_64bits_reset_withSecretandSeed XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_reset_withSecretandSeed)

Definition at line 480 of file xxhash.h.

◆ XXH3_64bits_reset_withSeed

#define XXH3_64bits_reset_withSeed XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_reset_withSeed)

Definition at line 478 of file xxhash.h.

◆ XXH3_64bits_update

#define XXH3_64bits_update XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_update)

Definition at line 481 of file xxhash.h.

◆ XXH3_64bits_withSecret

#define XXH3_64bits_withSecret XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_withSecret)

Definition at line 471 of file xxhash.h.

◆ XXH3_64bits_withSecretandSeed

#define XXH3_64bits_withSecretandSeed XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_withSecretandSeed)

Definition at line 473 of file xxhash.h.

◆ XXH3_64bits_withSeed

#define XXH3_64bits_withSeed XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_withSeed)

Definition at line 472 of file xxhash.h.

◆ XXH3_copyState

#define XXH3_copyState XXH_NAME2(XXH_NAMESPACE, XXH3_copyState)

Definition at line 476 of file xxhash.h.

◆ XXH3_createState

#define XXH3_createState XXH_NAME2(XXH_NAMESPACE, XXH3_createState)

Definition at line 474 of file xxhash.h.

◆ XXH3_freeState

#define XXH3_freeState XXH_NAME2(XXH_NAMESPACE, XXH3_freeState)

Definition at line 475 of file xxhash.h.

◆ XXH3_generateSecret

#define XXH3_generateSecret XXH_NAME2(XXH_NAMESPACE, XXH3_generateSecret)

Definition at line 483 of file xxhash.h.

◆ XXH3_generateSecret_fromSeed

#define XXH3_generateSecret_fromSeed XXH_NAME2(XXH_NAMESPACE, XXH3_generateSecret_fromSeed)

Definition at line 484 of file xxhash.h.

◆ XXH64

#define XXH64 XXH_NAME2(XXH_NAMESPACE, XXH64)

Definition at line 460 of file xxhash.h.

◆ XXH64_canonicalFromHash

#define XXH64_canonicalFromHash XXH_NAME2(XXH_NAMESPACE, XXH64_canonicalFromHash)

Definition at line 467 of file xxhash.h.

◆ XXH64_copyState

#define XXH64_copyState XXH_NAME2(XXH_NAMESPACE, XXH64_copyState)

Definition at line 466 of file xxhash.h.

◆ XXH64_digest

#define XXH64_digest XXH_NAME2(XXH_NAMESPACE, XXH64_digest)

Definition at line 465 of file xxhash.h.

◆ XXH64_freeState

#define XXH64_freeState XXH_NAME2(XXH_NAMESPACE, XXH64_freeState)

Definition at line 462 of file xxhash.h.

◆ XXH64_hashFromCanonical

#define XXH64_hashFromCanonical XXH_NAME2(XXH_NAMESPACE, XXH64_hashFromCanonical)

Definition at line 468 of file xxhash.h.

◆ XXH64_reset

#define XXH64_reset XXH_NAME2(XXH_NAMESPACE, XXH64_reset)

Definition at line 463 of file xxhash.h.

◆ XXH64_update

#define XXH64_update XXH_NAME2(XXH_NAMESPACE, XXH64_update)

Definition at line 464 of file xxhash.h.

◆ XXH_CAT

#define XXH_CAT	(	A,
		B
	)	A##B

Definition at line 446 of file xxhash.h.

◆ XXH_CONSTF

#define XXH_CONSTF /* disable */

Definition at line 526 of file xxhash.h.

◆ XXH_MALLOCF

#define XXH_MALLOCF

Definition at line 528 of file xxhash.h.

◆ XXH_NAME2

#define XXH_NAME2	(	A,
		B
	)	XXH_CAT(A,B)

Definition at line 447 of file xxhash.h.

◆ XXH_PUBLIC_API [1/2]

#define XXH_PUBLIC_API /* do nothing */

Marks a global symbol.

Definition at line 517 of file xxhash.h.

◆ XXH_PUBLIC_API [2/2]

#define XXH_PUBLIC_API /* do nothing */

Marks a global symbol.

Definition at line 517 of file xxhash.h.

◆ XXH_PUREF

#define XXH_PUREF

Definition at line 527 of file xxhash.h.

◆ XXH_VERSION_MAJOR

#define XXH_VERSION_MAJOR 0

Definition at line 534 of file xxhash.h.

◆ XXH_VERSION_MINOR

#define XXH_VERSION_MINOR 8

Definition at line 535 of file xxhash.h.

◆ XXH_VERSION_NUMBER

#define XXH_VERSION_NUMBER (XXH_VERSION_MAJOR *100*100 + XXH_VERSION_MINOR *100 + XXH_VERSION_RELEASE)

Version number, encoded as two digits each.

Definition at line 538 of file xxhash.h.

◆ XXH_VERSION_RELEASE

#define XXH_VERSION_RELEASE 2

Definition at line 536 of file xxhash.h.

◆ XXH_versionNumber

XXH_PUBLIC_API XXH_CONSTF unsigned XXH_versionNumber ( void ) XXH_NAME2(XXH_NAMESPACE, XXH_versionNumber)

Obtains the xxHash version.

This is mostly useful when xxHash is compiled as a shared library, since the returned value comes from the library, as opposed to header file.

Returns: XXH_VERSION_NUMBER of the invoked library.

Definition at line 448 of file xxhash.h.

◆ XXHASH_H_5627135585666179

#define XXHASH_H_5627135585666179 1

Definition at line 430 of file xxhash.h.

Typedef Documentation

◆ XXH64_hash_t

typedef unsigned long long XXH64_hash_t

Definition at line 858 of file xxhash.h.

Enumeration Type Documentation

◆ XXH_errorcode

enum XXH_errorcode

Exit code for the streaming API.

Enumerator
XXH_OK	OK
XXH_ERROR	Error

Definition at line 558 of file xxhash.h.

Modules

Macros

Enumerations