Aws::Crt::Checksum::XXHash Class Reference

#include <XXHash.h>

Public Member Functions
	XXHash (const XXHash &)=delete
XXHash &	operator= (const XXHash &)=delete
	XXHash (XXHash &&toMove) noexcept=default
XXHash &	operator= (XXHash &&toMove) noexcept=default
int	LastError () const noexcept
bool	Update (const ByteCursor &toHash) noexcept
bool	Digest (ByteBuf &output) noexcept

Static Public Member Functions
static XXHash	CreateXXHash64 (uint64_t seed=0, Allocator *allocator=ApiAllocator()) noexcept
static XXHash	CreateXXHash3_64 (uint64_t seed=0, Allocator *allocator=ApiAllocator()) noexcept
static XXHash	CreateXXHash3_128 (uint64_t seed=0, Allocator *allocator=ApiAllocator()) noexcept

Detailed Description

Streaming Hash object. The typical use case is for computing the hash of an object that is too large to load into memory. You can call Update() multiple times as you load chunks of data into memory. When you're finished simply call Digest(). After Digest() is called, this object is no longer usable.

Constructor & Destructor Documentation

XXHash() [1/2]

Aws::Crt::Checksum::XXHash::XXHash ( const XXHash &  )

delete

XXHash() [2/2]

Aws::Crt::Checksum::XXHash::XXHash ( XXHash &&  toMove )

defaultnoexcept

Member Function Documentation

CreateXXHash3_128()

XXHash Aws::Crt::Checksum::XXHash::CreateXXHash3_128 ( uint64_t  seed = 0, Allocator *  allocator = ApiAllocator()  )

staticnoexcept

Creates an instance of a Streaming XXHash3_128 Hash.

CreateXXHash3_64()

XXHash Aws::Crt::Checksum::XXHash::CreateXXHash3_64 ( uint64_t  seed = 0, Allocator *  allocator = ApiAllocator()  )

staticnoexcept

Creates an instance of a Streaming XXHash3_64 Hash.

CreateXXHash64()

XXHash Aws::Crt::Checksum::XXHash::CreateXXHash64 ( uint64_t  seed = 0, Allocator *  allocator = ApiAllocator()  )

staticnoexcept

Creates an instance of a Streaming XXHash64 Hash.

Digest()

bool Aws::Crt::Checksum::XXHash::Digest ( ByteBuf &  output )

noexcept

Finishes the running hash operation and writes the digest into output. Returns true on success. Call LastError() for the reason this call failed.

LastError()

int Aws::Crt::Checksum::XXHash::LastError ( ) const

inlinenoexcept

Returns the value of the last aws error encountered by operations on this instance.

operator=() [1/2]

XXHash & Aws::Crt::Checksum::XXHash::operator= ( const XXHash &  )

delete

operator=() [2/2]

XXHash & Aws::Crt::Checksum::XXHash::operator= ( XXHash &&  toMove )

defaultnoexcept

Update()

bool Aws::Crt::Checksum::XXHash::Update ( const ByteCursor &  toHash )

noexcept

Updates the running hash object with data in toHash. Returns true on success. Call LastError() for the reason this call failed.

---

The documentation for this class was generated from the following files:

• include/aws/crt/checksum/XXHash.h
• source/checksum/XXHash.cpp