VarInt.h File Reference

#include "CoreTypes.h"
#include "HAL/PlatformMath.h"

Go to the source code of this file.

Functions
FORCEINLINE uint32	MeasureVarUInt (const void *InData)
FORCEINLINE uint32	MeasureVarInt (const void *InData)
FORCEINLINE uint32	MeasureVarUInt (uint32 InValue)
FORCEINLINE uint32	MeasureVarUInt (uint64 InValue)
FORCEINLINE uint32	MeasureVarInt (int32 InValue)
FORCEINLINE uint32	MeasureVarInt (int64 InValue)
FORCEINLINE uint64	ReadVarUInt (const void *InData, uint32 &OutByteCount)
FORCEINLINE int64	ReadVarInt (const void *InData, uint32 &OutByteCount)
FORCEINLINE uint32	WriteVarUInt (uint32 InValue, void *OutData)
FORCEINLINE uint32	WriteVarUInt (uint64 InValue, void *OutData)
FORCEINLINE uint32	WriteVarInt (int32 InValue, void *OutData)
FORCEINLINE uint32	WriteVarInt (int64 InValue, void *OutData)
CORE_API int64	ReadVarIntFromArchive (FArchive &Ar)
CORE_API void	WriteVarIntToArchive (FArchive &Ar, int64 Value)
CORE_API void	SerializeVarInt (FArchive &Ar, int64 &Value)
CORE_API uint64	ReadVarUIntFromArchive (FArchive &Ar)
CORE_API void	WriteVarUIntToArchive (FArchive &Ar, uint64 Value)
CORE_API void	SerializeVarUInt (FArchive &Ar, uint64 &Value)

Function Documentation

MeasureVarInt() [1/3]

FORCEINLINE uint32 MeasureVarInt

(

const void *

InData

)

Measure the length in bytes (1-9) of an encoded variable-length integer.

See also

MeasureVarUInt

MeasureVarInt() [2/3]

FORCEINLINE uint32 MeasureVarInt

(

int32

InValue

)

Measure the number of bytes (1-5) required to encode the 32-bit input.

See also

MeasureVarUInt

MeasureVarInt() [3/3]

FORCEINLINE uint32 MeasureVarInt

(

int64

InValue

)

Measure the number of bytes (1-9) required to encode the 64-bit input.

See also

MeasureVarUInt

MeasureVarUInt() [1/3]

FORCEINLINE uint32 MeasureVarUInt

(

const void *

InData

)

Measure the length in bytes (1-9) of an encoded variable-length integer.

Parameters

InData

A variable-length encoding of an (signed or unsigned) integer.

Returns

The number of bytes used to encode the integer, in the range 1-9.

MeasureVarUInt() [2/3]

FORCEINLINE uint32 MeasureVarUInt

(

uint32

InValue

)

Measure the number of bytes (1-5) required to encode the 32-bit input.

MeasureVarUInt() [3/3]

FORCEINLINE uint32 MeasureVarUInt

(

uint64

InValue

)

Measure the number of bytes (1-9) required to encode the 64-bit input.

ReadVarInt()

FORCEINLINE int64 ReadVarInt	(	const void *	InData,
		uint32 &	OutByteCount
	)

Read a variable-length signed integer.

Parameters

InData	A variable-length encoding of a signed integer.
OutByteCount	The number of bytes consumed from the input.

Returns

A signed integer.

ReadVarIntFromArchive()

CORE_API int64 ReadVarIntFromArchive

(

FArchive &

Ar

)

ReadVarUInt()

FORCEINLINE uint64 ReadVarUInt	(	const void *	InData,
		uint32 &	OutByteCount
	)

Read a variable-length unsigned integer.

Parameters

InData	A variable-length encoding of an unsigned integer.
OutByteCount	The number of bytes consumed from the input.

Returns

An unsigned integer.

ReadVarUIntFromArchive()

CORE_API uint64 ReadVarUIntFromArchive

(

FArchive &

Ar

)

SerializeVarInt()

CORE_API void SerializeVarInt	(	FArchive &	Ar,
		int64 &	Value
	)

SerializeVarUInt()

CORE_API void SerializeVarUInt	(	FArchive &	Ar,
		uint64 &	Value
	)

WriteVarInt() [1/2]

FORCEINLINE uint32 WriteVarInt	(	int32	InValue,
		void *	OutData
	)

Write a variable-length signed integer.

See also

WriteVarUInt

WriteVarInt() [2/2]

FORCEINLINE uint32 WriteVarInt	(	int64	InValue,
		void *	OutData
	)

Write a variable-length signed integer.

See also

WriteVarUInt

WriteVarIntToArchive()

CORE_API void WriteVarIntToArchive	(	FArchive &	Ar,
		int64	Value
	)

WriteVarUInt() [1/2]

FORCEINLINE uint32 WriteVarUInt	(	uint32	InValue,
		void *	OutData
	)

Write a variable-length unsigned integer.

Parameters

InValue	An unsigned integer to encode.
OutData	A buffer of at least 5 bytes to write the output to.

Returns

The number of bytes used in the output.

WriteVarUInt() [2/2]

FORCEINLINE uint32 WriteVarUInt	(	uint64	InValue,
		void *	OutData
	)

Write a variable-length unsigned integer.

Parameters

InValue	An unsigned integer to encode.
OutData	A buffer of at least 9 bytes to write the output to.

Returns

The number of bytes used in the output.

WriteVarUIntToArchive()

CORE_API void WriteVarUIntToArchive	(	FArchive &	Ar,
		uint64	Value
	)