Base64.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/UnrealString.h"
#include "CoreTypes.h"
#include "Misc/Timespan.h"
 
enum class EBase64Mode : uint8
{
    Standard,
    UrlSafe
};
 
struct FBase64
{
    static CORE_API FString Encode(const FString& Source, EBase64Mode Mode = EBase64Mode::Standard);
 
    static CORE_API FString Encode(const TArray<uint8>& Source, EBase64Mode Mode = EBase64Mode::Standard);
 
    static CORE_API FString Encode(const uint8* Source, uint32 Length, EBase64Mode Mode = EBase64Mode::Standard);
 
    template<typename CharType>
    CORE_API static uint32 Encode(const uint8* Source, uint32 Length, CharType* Dest, EBase64Mode Mode = EBase64Mode::Standard);
 
    static inline constexpr uint32 GetEncodedDataSize(uint32 NumBytes)
    {
        return ((NumBytes + 2) / 3) * 4;
    }
 
    static CORE_API bool Decode(const FString& Source, FString& OutDest, EBase64Mode Mode = EBase64Mode::Standard);
 
    static CORE_API bool Decode(const FString& Source, TArray<uint8>& Dest, EBase64Mode Mode = EBase64Mode::Standard);
 
    template<typename CharType>
    CORE_API static bool Decode(const CharType* Source, uint32 Length, uint8* Dest, EBase64Mode Mode = EBase64Mode::Standard);
 
    static CORE_API uint32 GetDecodedDataSize(const FString& Source);
 
    template<typename CharType>
    CORE_API static uint32 GetDecodedDataSize(const CharType* Source, uint32 Length);
 
    static inline constexpr uint32 GetMaxDecodedDataSize(uint32 NumChars)
    {
        return ((NumChars * 3) + 3) / 4;
    }
};