FCborWriter Class Reference

#include <CborWriter.h>

Public Member Functions
CBOR_API	FCborWriter (FArchive *InStream, ECborEndianness InWriterEndianness=ECborEndianness::Platform)
CBOR_API	~FCborWriter ()
CBOR_API const FArchive *	GetArchive () const
CBOR_API void	WriteContainerStart (ECborCode ContainerType, int64 NbItem)
CBOR_API void	WriteContainerEnd ()
CBOR_API void	WriteNull ()
CBOR_API void	WriteValue (uint64 Value)
CBOR_API void	WriteValue (int64 Value)
CBOR_API void	WriteValue (bool Value)
CBOR_API void	WriteValue (float Value)
CBOR_API void	WriteValue (double Value)
CBOR_API void	WriteValue (const FString &Value)
CBOR_API void	WriteValue (const FAnsiString &Value)
CBOR_API void	WriteValue (const FUtf8String &Value)
CBOR_API void	WriteValue (const FStringView &Value)
CBOR_API void	WriteValue (const FUtf8StringView &Value)
CBOR_API void	WriteValue (const char *CString, uint64 Length)
CBOR_API void	WriteValue (const uint8 *Bytes, uint64 Length)

Detailed Description

Writer for encoding a stream with the cbor protocol

See also

http://cbor.io

Constructor & Destructor Documentation

FCborWriter()

FCborWriter::FCborWriter	(	FArchive *	InStream,
		ECborEndianness	InWriterEndianness = ECborEndianness::Platform
	)

~FCborWriter()

FCborWriter::~FCborWriter

(

)

Member Function Documentation

GetArchive()

const FArchive * FCborWriter::GetArchive

(

)

const

Returns

the archive we are writing to.

WriteContainerEnd()

void FCborWriter::WriteContainerEnd

(

)

Write a container break code, need a indefinite container context.

WriteContainerStart()

void FCborWriter::WriteContainerStart	(	ECborCode	ContainerType,
		int64	NbItem
	)

Write a container start code.

Parameters

ContainerType	container major type, either array or map.
NbItem	the number of item in the container or negative to indicate indefinite containers.

WriteNull()

void FCborWriter::WriteNull

(

)

Write a value.

WriteValue() [1/12]

void FCborWriter::WriteValue

(

bool

Value

)

WriteValue() [2/12]

void FCborWriter::WriteValue	(	const char *	CString,
		uint64	Length
	)

WriteValue() [3/12]

void FCborWriter::WriteValue

(

const FAnsiString &

Value

)

WriteValue() [4/12]

void FCborWriter::WriteValue

(

const FString &

Value

)

WriteValue() [5/12]

void FCborWriter::WriteValue

(

const FStringView &

Value

)

WriteValue() [6/12]

void FCborWriter::WriteValue

(

const FUtf8String &

Value

)

WriteValue() [7/12]

void FCborWriter::WriteValue

(

const FUtf8StringView &

Value

)

WriteValue() [8/12]

void FCborWriter::WriteValue	(	const uint8 *	Bytes,
		uint64	Length
	)

WriteValue() [9/12]

void FCborWriter::WriteValue

(

double

Value

)

WriteValue() [10/12]

void FCborWriter::WriteValue

(

float

Value

)

WriteValue() [11/12]

void FCborWriter::WriteValue

(

int64

Value

)

WriteValue() [12/12]

void FCborWriter::WriteValue

(

uint64

Value

)

---

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

• Engine/Source/Runtime/Cbor/Public/CborWriter.h
• Engine/Source/Runtime/Cbor/Private/CborWriter.cpp