FileSystemOperations.h

// Copyright (c) Stefano Cristiano
// SPDX-License-Identifier: MIT
#pragma once
#include "../Foundation/Result.h"
#include "../Foundation/StringViewData.h"
#include "../Time/Time.h"
 
namespace SC
{
struct FileSystemStat
{
    size_t         fileSize     = 0; 
    Time::Realtime modifiedTime = 0; 
};
 
struct FileSystemCopyFlags
{
    FileSystemCopyFlags()
    {
        overwrite           = false;
        useCloneIfSupported = true;
    }
 
    FileSystemCopyFlags& setOverwrite(bool value)
    {
        overwrite = value;
        return *this;
    }
 
    FileSystemCopyFlags& setUseCloneIfSupported(bool value)
    {
        useCloneIfSupported = value;
        return *this;
    }
 
    bool overwrite;           
    bool useCloneIfSupported; 
};
 
struct FileSystemOperations
{
    static Result createSymbolicLink(StringViewData sourceFileOrDirectory, StringViewData linkFile);
 
    static Result makeDirectory(StringViewData dir);
 
    static Result exists(StringViewData path);
 
    static Result existsAndIsDirectory(StringViewData path);
 
    static Result existsAndIsFile(StringViewData path);
 
    static Result existsAndIsLink(StringViewData path);
 
    static Result removeEmptyDirectory(StringViewData path);
 
    static Result moveDirectory(StringViewData source, StringViewData destination);
 
    static Result removeFile(StringViewData path);
 
    static Result copyFile(StringViewData srcPath, StringViewData destPath, FileSystemCopyFlags flags);
 
    static Result rename(StringViewData path, StringViewData newPath);
 
    static Result copyDirectory(StringViewData srcPath, StringViewData destPath, FileSystemCopyFlags flags);
 
    static Result removeDirectoryRecursive(StringViewData directory);
 
    static Result getFileStat(StringViewData path, FileSystemStat& fileStat);
 
    static Result setLastModifiedTime(StringViewData path, Time::Realtime time);
 
  private:
    struct Internal;
};
} // namespace SC