CborWriter.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CborTypes.h"
#include "Containers/ContainersFwd.h"
#include "Containers/Array.h"
#include "Containers/StringFwd.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "HAL/Platform.h"
 
class FArchive;
 
class FCborWriter
{
public:
    /*
     * Construct a CBOR writer.
     * @param InStream The stream used to write the CBOR data.
     * @param InWriterEndianness Specify which endianness should be use to write the archive.
     * @note CBOR standard endianness is big endian. For interoperability with external tools, the standard endianness should be used. For internal usage, the platform endianness is faster.
     */
    CBOR_API FCborWriter(FArchive* InStream, ECborEndianness InWriterEndianness = ECborEndianness::Platform);
    CBOR_API ~FCborWriter();
 
public:
    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);
 
private:
    static FCborHeader WriteUIntValue(FCborHeader Header, FArchive& Ar, uint64 Value);
 
    void CheckContext(ECborCode MajorType);
 
    FArchive* Stream;
    TArray<FCborContext> ContextStack;
    ECborEndianness Endianness;
};