FCborContext Struct Reference

#include <CborTypes.h>

Public Member Functions
	FCborContext ()
void	Reset ()
ECborCode	RawCode () const
ECborCode	MajorType () const
ECborCode	AdditionalValue () const
bool	IsDummy ()
bool	IsError () const
bool	IsBreak () const
bool	IsString () const
bool	IsContainer () const
bool	IsIndefiniteContainer () const
bool	IsFiniteContainer () const
ECborCode	AsBreak () const
uint64	AsLength () const
uint64	AsUInt () const
int64	AsInt () const
bool	AsBool () const
float	AsFloat () const
double	AsDouble () const
FString	AsString () const
FAnsiString	AsAnsiString () const
FUtf8String	AsUtf8String () const
const char *	AsCString () const
TArrayView< const uint8 >	AsByteArray () const

Friends
class	FCborReader
class	FCborWriter

Detailed Description

class that represent a cbor context which consists of a header and value pair

Constructor & Destructor Documentation

FCborContext()

FCborContext::FCborContext ( )

inline

Member Function Documentation

AdditionalValue()

ECborCode FCborContext::AdditionalValue ( ) const

inline

Returns

the context header additional value.

AsAnsiString()

FAnsiString FCborContext::AsAnsiString ( ) const

inline

Returns

the context as a string.

AsBool()

bool FCborContext::AsBool ( ) const

inline

Returns

the context as a bool.

AsBreak()

ECborCode FCborContext::AsBreak ( ) const

inline

Returns

the context as the container code the break context is associated with.

AsByteArray()

TArrayView< const uint8 > FCborContext::AsByteArray ( ) const

inline

Returns

the context as a raw byte array.

AsCString()

const char * FCborContext::AsCString ( ) const

inline

Returns

the context as a C string.

AsDouble()

double FCborContext::AsDouble ( ) const

inline

Returns

the context as a double.

AsFloat()

float FCborContext::AsFloat ( ) const

inline

Returns

the context as a float.

AsInt()

int64 FCborContext::AsInt ( ) const

inline

Returns

the context as an int.

AsLength()

uint64 FCborContext::AsLength ( ) const

inline

Returns

the context as a container length. Map container returns their length as twice their number of pairs.

AsString()

FString FCborContext::AsString ( ) const

inline

Returns

the context as a string.

AsUInt()

uint64 FCborContext::AsUInt ( ) const

inline

Returns

the context as an unsigned int.

AsUtf8String()

FUtf8String FCborContext::AsUtf8String ( ) const

inline

Returns

the context as a string.

IsBreak()

bool FCborContext::IsBreak ( ) const

inline

Returns

true if this context represent a break code.

IsContainer()

bool FCborContext::IsContainer ( ) const

inline

Returns

true if this context represents a container. (indefinite string are containers.)

IsDummy()

bool FCborContext::IsDummy ( )

inline

Returns

true if this is a dummy context.

IsError()

bool FCborContext::IsError ( ) const

inline

Returns

true if this context represents an error code.

IsFiniteContainer()

bool FCborContext::IsFiniteContainer ( ) const

inline

Returns

true if this context represents an finite container.

IsIndefiniteContainer()

bool FCborContext::IsIndefiniteContainer ( ) const

inline

Returns

true if this context represents an indefinite container.

IsString()

bool FCborContext::IsString ( ) const

inline

Returns

true if this context represents a string type.

MajorType()

ECborCode FCborContext::MajorType ( ) const

inline

Returns

the context header major type.

RawCode()

ECborCode FCborContext::RawCode ( ) const

inline

Returns

the context header raw code.

Reset()

void FCborContext::Reset ( )

inline

Reset the context to a dummy state.

Friends And Related Symbol Documentation

FCborReader

friend class FCborReader

friend

FCborWriter

friend class FCborWriter

friend

Member Data Documentation

BoolValue

bool FCborContext::BoolValue

DoubleValue

double FCborContext::DoubleValue

FloatValue

float FCborContext::FloatValue

IntValue

int64 FCborContext::IntValue

Length

uint64 FCborContext::Length

UIntValue

uint64 FCborContext::UIntValue

---

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

• Engine/Source/Runtime/Cbor/Public/CborTypes.h