RandomAccess.h

#pragma once
 
#include <iolink/FlagSet.h>
#include <iolink/IOLinkAPI.h>
#include <iolink/storage/DataAccess.h>
 
#include <cstdint>
 
namespace iolink
{
 
enum class RandomAccessCapability
{
  READ = 0x1,          
  WRITE = 0x2,         
  RESIZE = 0x4,        
  MEMORY_ACCESS = 0x8, 
 
  READ_WRITE = 0x3,   
  WRITE_RESIZE = 0x6, 
};
 
extern template class IOLINK_API_IMPORT FlagSet<RandomAccessCapability>;
 
using RandomAccessCapabilitySet = FlagSet<RandomAccessCapability>;
 
// Define bitwise operators for RandomAccessCapability
IOLINK_DEFINE_ENUM_BITWISE_OPERATORS(RandomAccessCapability)
 
 
class IOLINK_API RandomAccess : public DataAccess
{
public:
  virtual ~RandomAccess() = default;
 
  virtual RandomAccessCapabilitySet capabilities() const = 0;
 
  inline bool support(RandomAccessCapabilitySet flags) { return this->capabilities().has(flags); }
 
  virtual size_t size() const = 0;
 
  std::string toString() const;
 
  // ==== //
  // READ //
  // ==== //
 
  virtual size_t read(size_t offset, size_t size, void* dst);
 
  // ===== //
  // WRITE //
  // ===== //
 
  virtual size_t write(size_t offset, size_t size, const void* src);
 
  // ====== //
  // RESIZE //
  // ====== //
 
  virtual void resize(size_t newSize);
 
  // ============= //
  // MEMORY_ACCESS //
  // ============= //
 
  virtual void* buffer();
 
  virtual const void* bufferReadOnly() const;
 
  virtual size_t bufferSize();
};
 
} // namespace iolink