UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | Static Public Member Functions | Friends | List of all members
FPersistentStorageManager Class Reference

#include <IPlatformFileManagedStorageWrapper.h>

Public Member Functions

 FPersistentStorageManager ()
 
void Initialize ()
 
FPersistentManagedFile TryManageFile (const FString &Filename)
 
FPersistentManagedFile TryManageFile (FString &&Filename)
 
bool TryManageFile (FPersistentManagedFile &InOutFile)
 
EPersistentStorageManagerFileSizeFlags AddOrUpdateFile (const FPersistentManagedFile &File, const int64 FileSize, EPersistentStorageManagerFileSizeFlags Flags=EPersistentStorageManagerFileSizeFlags::None)
 
bool RemoveFileFromManager (FPersistentManagedFile &File)
 
int64 GetTotalUsedSize () const
 
bool GetPersistentStorageUsage (FString Path, int64 &UsedSpace, int64 &RemainingSpace, int64 &Quota, int64 *OptionalQuota=nullptr)
 
bool GetPersistentStorageUsageByCategory (const FString &InCategory, int64 &UsedSpace, int64 &RemainingSpace, int64 &Quota, int64 *OptionalQuota=nullptr)
 
bool GetPersistentStorageSize (int64 &UsedSpace, int64 &RequiredSpace, int64 &OptionalSpace) const
 Returns any additional required free space and optional free space.
 
bool IsInitialized () const
 
bool IsCategoryForFileFull (const FPersistentManagedFile &File) const
 
TMap< FString, FPersistentStorageCategory::CategoryStat > GenerateCategoryStats () const
 
TOptional< FPersistentStorageCategory::CategoryStat > GetCategoryStat (const FString &InCategory) const
 
TArrayView< const FString > GetRootDirectories () const
 

Static Public Member Functions

static bool IsReady ()
 
static CORE_API FPersistentStorageManager & Get ()
 

Friends

class FManagedStorageScopeFileLock
 

Constructor & Destructor Documentation

◆ FPersistentStorageManager()

FPersistentStorageManager::FPersistentStorageManager ( )

Member Function Documentation

◆ AddOrUpdateFile()

EPersistentStorageManagerFileSizeFlags FPersistentStorageManager::AddOrUpdateFile ( const FPersistentManagedFile &  File,
const int64  FileSize,
EPersistentStorageManagerFileSizeFlags  Flags = EPersistentStorageManagerFileSizeFlags::None 
)
inline

◆ GenerateCategoryStats()

TMap< FString, FPersistentStorageCategory::CategoryStat > FPersistentStorageManager::GenerateCategoryStats ( ) const
inline

◆ Get()

FPersistentStorageManager & FPersistentStorageManager::Get ( )
static

Singleton access

◆ GetCategoryStat()

TOptional< FPersistentStorageCategory::CategoryStat > FPersistentStorageManager::GetCategoryStat ( const FString &  InCategory) const
inline

◆ GetPersistentStorageSize()

bool FPersistentStorageManager::GetPersistentStorageSize ( int64 &  UsedSpace,
int64 &  RequiredSpace,
int64 &  OptionalSpace 
) const
inline

Returns any additional required free space and optional free space.

Parameters
RequiredSpaceRequired persistent storage space to run
OptionalSpacepersistent storage categories marked as optional
Returns

◆ GetPersistentStorageUsage()

bool FPersistentStorageManager::GetPersistentStorageUsage ( FString  Path,
int64 &  UsedSpace,
int64 &  RemainingSpace,
int64 &  Quota,
int64 *  OptionalQuota = nullptr 
)
inline
Parameters
Pathpath to check for free space
UsedSpaceamount of used space
RemainingSpaceamount of remaining free space
Quotatotal storage allocated to the related category
OptionalQuotasubset of the storage which is optional i.e. will always be smaller then total Quota
Returns
returns if function succeeds

◆ GetPersistentStorageUsageByCategory()

bool FPersistentStorageManager::GetPersistentStorageUsageByCategory ( const FString &  InCategory,
int64 &  UsedSpace,
int64 &  RemainingSpace,
int64 &  Quota,
int64 *  OptionalQuota = nullptr 
)
inline

◆ GetRootDirectories()

TArrayView< const FString > FPersistentStorageManager::GetRootDirectories ( ) const
inline

◆ GetTotalUsedSize()

int64 FPersistentStorageManager::GetTotalUsedSize ( ) const
inline

◆ Initialize()

void FPersistentStorageManager::Initialize ( )
inline

◆ IsCategoryForFileFull()

bool FPersistentStorageManager::IsCategoryForFileFull ( const FPersistentManagedFile &  File) const
inline

◆ IsInitialized()

bool FPersistentStorageManager::IsInitialized ( ) const
inline

◆ IsReady()

static bool FPersistentStorageManager::IsReady ( )
inlinestatic

◆ RemoveFileFromManager()

bool FPersistentStorageManager::RemoveFileFromManager ( FPersistentManagedFile &  File)
inline

◆ TryManageFile() [1/3]

FPersistentManagedFile FPersistentStorageManager::TryManageFile ( const FString &  Filename)
inline

◆ TryManageFile() [2/3]

bool FPersistentStorageManager::TryManageFile ( FPersistentManagedFile &  InOutFile)
inline

◆ TryManageFile() [3/3]

FPersistentManagedFile FPersistentStorageManager::TryManageFile ( FString &&  Filename)
inline

Friends And Related Symbol Documentation

◆ FManagedStorageScopeFileLock

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