mgl_file_delegate.h

[詳解]

// SPDX-License-Identifier: Zlib
/* ------------------------------------------------------------------------- */
/* ------------------------------------------------------------------------- */
 
#ifndef INCGUARD_MGL_FILE_DELEGATE_H_1611104162
#define INCGUARD_MGL_FILE_DELEGATE_H_1611104162
 
#include <cstddef>
 
#include <mgl/file/mgl_file_access_work.h>
#include <mgl/file/mgl_file_defs.h>
#include <mgl/file/mgl_file_mount_work.h>
#include <mgl/file/mgl_file_path_view.h>
 
namespace MGL::File
{
class Delegate
{
public:
    virtual ~Delegate() noexcept = default;
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    [[nodiscard]] virtual bool IsManagedSystemNativeFile() const noexcept = 0;
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    [[nodiscard]] virtual bool IsWritable() const noexcept = 0;
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    virtual Result Mount(SharedMountWork &mountWork, const PathView &path, MountAccessType accessType) noexcept = 0;
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    virtual void Unmount(SharedMountWork &mountWork) noexcept = 0;
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    virtual AccessWorkPtr Open(Result &result, SharedMountWork &mountWork, const PathView &path, OpenMode mode) noexcept = 0;
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    virtual Result Close(AccessWork *work) noexcept = 0;
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    virtual size_t Read(AccessWork *work, Result &result, void *buffer, size_t size) noexcept = 0;
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    virtual size_t Write(AccessWork *work, Result &result, const void *buffer, size_t size) noexcept = 0;
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    virtual size_t Seek(AccessWork *work, Result &result, SeekType seekType, int32_t offset) noexcept = 0;
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    virtual size_t GetOffset(AccessWork *work, Result &result) const noexcept = 0;
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    virtual bool IsEOF(AccessWork *work, Result &result) const noexcept = 0;
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    virtual size_t GetSize(AccessWork *work, Result &result) const noexcept = 0;
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    virtual size_t GetSize(MountWork *mountWork, Result &result, const PathView &path) const noexcept = 0;
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    virtual Result MakeDirectory(MountWork *mountWork, const PathView &path) noexcept = 0;
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    virtual Result Move(MountWork *mountWork, const PathView &sourcePath, const PathView &destPath) noexcept = 0;
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    virtual Result Remove(MountWork *mountWork, const PathView &path) noexcept = 0;
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    virtual bool Exists(MountWork *mountWork, Result &result, const PathView &path) noexcept = 0;
};
 
}    // namespace MGL::File
 
#endif    // INCGUARD_MGL_FILE_DELEGATE_H_1611104162
 
// vim: et ts=4 sw=4 sts=4