FileContents.h

Go to the documentation of this file.

#pragma once
 
#include "../StringView.h"
#include "../Memory/MemoryBuffer.h"
 
#include <functional>
#include <memory>
 
namespace Cogs {
 
  enum struct FileContentsHints : uint32_t {
    None = 0,
    ZStdDecompress = 1 << 0,
    BrotliDecompress = 1 << 1
  };
 
  struct COGSFOUNDATION_API FileContents {
 
 
    using Ptr = std::unique_ptr<FileContents>;
    using Callback = std::function<void(Ptr&&)>;
 
    const uint8_t* ptr;
    size_t                size;
    size_t                mimeTypeHash = 0;
    FileContentsHints     hints = FileContentsHints::None;
 
  public:
    FileContents() = delete;
    FileContents(const uint8_t* ptr, size_t size, FileContentsHints hints) : ptr(ptr), size(size), hints(hints) {}
    FileContents(const FileContents&) = delete;
 
    virtual ~FileContents() = default;
 
    FileContents& operator=(const FileContents&) = delete;
 
    [[nodiscard]] Memory::MemoryBuffer  takeCopy();
 
    [[nodiscard]] constexpr const void*         data() const { return ptr; }
 
    [[nodiscard]] virtual Memory::MemoryBuffer  take() = 0;
 
    [[nodiscard]] virtual StringView            origin() = 0;
  };
}