FFileStorageClient | Unreal Engine 5.7 Documentation

Implementation of FStorageClient which writes data to files on disk.


Name	FFileStorageClient
Type	class
Header File	/Engine/Source/Developer/Horde/Public/Storage/Clients/FileStorageClient.h
Include Path	#include "Storage/Clients/FileStorageClient.h"

Syntax

class FFileStorageClient : public FKeyValueStorageClient

TSharedFromThis< FStorageClient, ESPMode::ThreadSafe > → FStorageClient → FKeyValueStorageClient → FFileStorageClient

Name	Remarks	Include Path	Unreal Specifiers
FFileStorageClient ( std::filesystem::path InRootDir )		Storage/Clients/FileStorageClient.h

Name	Remarks	Include Path	Unreal Specifiers
~FFileStorageClient()		Storage/Clients/FileStorageClient.h

Name	Type	Remarks	Include Path	Unreal Specifiers
RootDir	std::filesystem::path		Storage/Clients/FileStorageClient.h

Name	Remarks	Include Path	Unreal Specifiers
std::filesystem::path GetBlobFile ( const FBlobLocator& Locator ) const		Storage/Clients/FileStorageClient.h
std::filesystem::path GetRefFile ( const FRefName& Name ) const		Storage/Clients/FileStorageClient.h

Name	Remarks	Include Path
virtual void AddAlias ( const char* Name, FBlobAlias Alias )	Aliases Adds an alias to a given blob.	Storage/Clients/FileStorageClient.h
virtual bool DeleteRef ( const FRefName& Name )	Refs Deletes a ref.	Storage/Clients/FileStorageClient.h
virtual void FindAliases ( const char* Name, int MaxResults, TArray< FBlobAlias >& OutAliases )	Finds blobs with the given alias. Unlike refs, aliases do not serve as GC roots.	Storage/Clients/FileStorageClient.h
virtual FBlobHandle ReadRef ( const FRefName& Name, const FRefCacheTime& CacheTime ) const	Reads data for a ref from the store.	Storage/Clients/FileStorageClient.h
virtual void RemoveAlias ( const char* Name, FBlobHandle Handle )	Removes an alias from a blob.	Storage/Clients/FileStorageClient.h
virtual void WriteRef ( const FRefName& Name, const FBlobHandle& Handle, const FRefOptions& Options )		Storage/Clients/FileStorageClient.h

Name	Remarks	Include Path	Unreal Specifiers
virtual FBlob ReadBlob ( const FBlobLocator& Locator ) const	Read a single blob from the underlying store.	Storage/Clients/FileStorageClient.h
virtual FBlobHandle WriteBlob ( const FUtf8StringView& BasePath, const FBlobType& Type, const TArrayView< FMemoryView >& Data, const TArrayView< FBlobHandle >& Imports )	Write a single blob to the underlying store.	Storage/Clients/FileStorageClient.h

Name	Remarks	Include Path	Unreal Specifiers
static FBlobLocator ReadRefFromFile ( const std::filesystem::path& File )		Storage/Clients/FileStorageClient.h
static void WriteRefToFile ( const std::filesystem::path& File, const FBlobLocator& Locator )		Storage/Clients/FileStorageClient.h