UE::Virtualization::FPushResult Struct Reference

#include <VirtualizationSystem.h>

Public Types
enum class	EStatus : int8 {   Error = -5 , ProcessDisabled = -4 , NoBackend = -3 , Invalid = -2 ,   Filtered = -1 , Pending = 0 , AlreadyExisted = 1 , Pushed = 2 }

Public Member Functions
	FPushResult ()=default
	~FPushResult ()=default
bool	WasPushed () const
bool	WasError () const
bool	IsVirtualized () const
bool	IsFiltered () const
EPayloadFilterReason	GetFilterReason () const

Static Public Member Functions
static FPushResult	GetAsError ()
static FPushResult	GetAsProcessDisabled ()
static FPushResult	GetAsNoBackend ()
static FPushResult	GetAsInvalid ()
static FPushResult	GetAsFiltered (EPayloadFilterReason Reason)
static FPushResult	GetAsAlreadyExists ()
static FPushResult	GetAsPushed ()

Detailed Description

The result of a push operation on a single payload

Member Enumeration Documentation

EStatus

enum class UE::Virtualization::FPushResult::EStatus : int8

strong

Records the status of the push, negative values indicate an error, positive values indicate that the payload is stored in the target backend(s) and a zero value means that the operation has not yet run

Enumerator
Error	The push operation caused an error
ProcessDisabled	The push operation storage type is disabled
NoBackend	There were no backends that supported the push operation
Invalid	The push operation was run on an invalid payload id
Filtered	The payload was rejected by the filtering system
Pending	The push operation has not yet been run
AlreadyExisted	The payload was already present in the target backend(s)
Pushed	The payload was pushed to the backend(s)

Constructor & Destructor Documentation

FPushResult()

UE::Virtualization::FPushResult::FPushResult ( )

default

~FPushResult()

UE::Virtualization::FPushResult::~FPushResult ( )

default

Member Function Documentation

GetAsAlreadyExists()

static FPushResult UE::Virtualization::FPushResult::GetAsAlreadyExists ( )

inlinestatic

GetAsError()

static FPushResult UE::Virtualization::FPushResult::GetAsError ( )

inlinestatic

GetAsFiltered()

static FPushResult UE::Virtualization::FPushResult::GetAsFiltered ( EPayloadFilterReason  Reason )

inlinestatic

GetAsInvalid()

static FPushResult UE::Virtualization::FPushResult::GetAsInvalid ( )

inlinestatic

GetAsNoBackend()

static FPushResult UE::Virtualization::FPushResult::GetAsNoBackend ( )

inlinestatic

GetAsProcessDisabled()

static FPushResult UE::Virtualization::FPushResult::GetAsProcessDisabled ( )

inlinestatic

GetAsPushed()

static FPushResult UE::Virtualization::FPushResult::GetAsPushed ( )

inlinestatic

GetFilterReason()

EPayloadFilterReason UE::Virtualization::FPushResult::GetFilterReason ( ) const

inline

Returns why the payload was rejected by the filtering system (if there was one)

IsFiltered()

bool UE::Virtualization::FPushResult::IsFiltered ( ) const

inline

Returns true if the payload was rejected by the filtering system

IsVirtualized()

bool UE::Virtualization::FPushResult::IsVirtualized ( ) const

inline

Returns true if the payload is stored in the target backend(s) after the operation completed

WasError()

bool UE::Virtualization::FPushResult::WasError ( ) const

inline

Returns true if the payload experienced an error during upload

WasPushed()

bool UE::Virtualization::FPushResult::WasPushed ( ) const

inline

Returns true if the payload was actually uploaded to the target backend(s)

---

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

• Engine/Source/Runtime/Core/Public/Virtualization/VirtualizationSystem.h