Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
FMD5Hash Struct Reference

#include <SecureHash.h>

Public Member Functions

 FMD5Hash ()
 
bool IsValid () const
 
void Set (FMD5 &MD5)
 
const uint8 * GetBytes () const
 
const int32 GetSize () const
 

Static Public Member Functions

static FMD5Hash HashFile (const TCHAR *InFilename, TArray< uint8 > *Buffer=nullptr)
 
static FMD5Hash HashFileFromArchive (FArchive *Ar, TArray< uint8 > *ScratchPad=nullptr)
 

Private Member Functions

FCbWriter & WriteCompactBinary (FCbWriter &Writer) const
 

Private Attributes

bool bIsValid
 
uint8 Bytes [16]
 

Friends

bool operator== (const FMD5Hash &LHS, const FMD5Hash &RHS)
 
bool operator!= (const FMD5Hash &LHS, const FMD5Hash &RHS)
 
FArchive & operator<< (FArchive &Ar, FMD5Hash &Hash)
 
FCbWriter & operator<< (FCbWriter &Writer, const FMD5Hash &Hash)
 
bool LoadFromCompactBinary (FCbFieldView Field, FMD5Hash &OutHash)
 
FString LexToString (const FMD5Hash &)
 
void LexFromString (FMD5Hash &Hash, const TCHAR *)
 

Detailed Description

Simple helper struct to ease the caching of MD5 hashes

Definition at line 138 of file SecureHash.h.

Constructor & Destructor Documentation

◆ FMD5Hash()

FMD5Hash::FMD5Hash ( )
inline

Default constructor

Definition at line 141 of file SecureHash.h.

Member Function Documentation

◆ GetBytes()

const uint8 * FMD5Hash::GetBytes ( ) const
inline

Definition at line 181 of file SecureHash.h.

+ Here is the caller graph for this function:

◆ GetSize()

const int32 FMD5Hash::GetSize ( ) const
inline

Definition at line 182 of file SecureHash.h.

◆ HashFile()

static FMD5Hash FMD5Hash::HashFile ( const TCHAR * InFilename,
TArray< uint8 > * Buffer = nullptr )
static

Hash the specified file contents (using the optionally supplied scratch buffer)

◆ HashFileFromArchive()

static FMD5Hash FMD5Hash::HashFileFromArchive ( FArchive * Ar,
TArray< uint8 > * ScratchPad = nullptr )
static

◆ IsValid()

bool FMD5Hash::IsValid ( ) const
inline

Check whether this has hash is valid or not

Definition at line 144 of file SecureHash.h.

◆ Set()

void FMD5Hash::Set ( FMD5 & MD5)
inline

Set up the MD5 hash from a container

Definition at line 147 of file SecureHash.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ WriteCompactBinary()

FCbWriter & FMD5Hash::WriteCompactBinary ( FCbWriter & Writer) const
private

Friends And Related Symbol Documentation

◆ LexFromString

void LexFromString ( FMD5Hash & Hash,
const TCHAR *  )
friend

◆ LexToString

FString LexToString ( const FMD5Hash & )
friend

◆ LoadFromCompactBinary

bool LoadFromCompactBinary ( FCbFieldView Field,
FMD5Hash & OutHash )
friend

◆ operator!=

bool operator!= ( const FMD5Hash & LHS,
const FMD5Hash & RHS )
friend

Compare one hash with another

Definition at line 160 of file SecureHash.h.

◆ operator<< [1/2]

FArchive & operator<< ( FArchive & Ar,
FMD5Hash & Hash )
friend

Serialise this hash

Definition at line 166 of file SecureHash.h.

◆ operator<< [2/2]

FCbWriter & operator<< ( FCbWriter & Writer,
const FMD5Hash & Hash )
friend

Definition at line 191 of file SecureHash.h.

◆ operator==

bool operator== ( const FMD5Hash & LHS,
const FMD5Hash & RHS )
friend

Compare one hash with another

Definition at line 154 of file SecureHash.h.

Member Data Documentation

◆ bIsValid

bool FMD5Hash::bIsValid
private

Whether this hash is valid or not

Definition at line 186 of file SecureHash.h.

◆ Bytes

uint8 FMD5Hash::Bytes[16]
private

The bytes this hash comprises

Definition at line 189 of file SecureHash.h.

The documentation for this struct was generated from the following file: