Archive.h

Go to the documentation of this file.

//===-- serialbox/core/archive/Archive.h --------------------------------------------*- C++ -*-===//
//
//                                    S E R I A L B O X
//
// This file is distributed under terms of BSD license.
// See LICENSE.txt for more information
//
//===------------------------------------------------------------------------------------------===//
//
//===------------------------------------------------------------------------------------------===//

#ifndef SERIALBOX_CORE_ARCHIVE_ARCHIVE_H
#define SERIALBOX_CORE_ARCHIVE_ARCHIVE_H

#include "serialbox/core/Exception.h"
#include "serialbox/core/FieldID.h"
#include "serialbox/core/FieldMetainfoImpl.h"
#include "serialbox/core/StorageView.h"
#include "serialbox/core/Type.h"
#include <iosfwd>

namespace serialbox {

class Archive {
public:
  virtual ~Archive() {}

  virtual FieldID write(const StorageView& storageView, const std::string& field,
                        const std::shared_ptr<FieldMetainfoImpl> info) = 0;

  virtual void read(StorageView& storageView, const FieldID& fieldID,
                    std::shared_ptr<FieldMetainfoImpl> info) const = 0;

  virtual void updateMetaData() = 0;

  virtual std::string name() const = 0;

  virtual OpenModeKind mode() const = 0;

  virtual std::string directory() const = 0;

  virtual std::string prefix() const = 0;

  virtual std::string metaDataFile() const = 0;

  virtual void clear() = 0;

  virtual bool isReadingThreadSafe() const { return false; }

  virtual bool isWritingThreadSafe() const { return false; }

  virtual bool isSlicedReadingSupported() const { return false; }

  virtual std::ostream& toStream(std::ostream& stream) const = 0;

  friend std::ostream& operator<<(std::ostream& stream, const Archive& archive) {
    return archive.toStream(stream);
  }
};

} // namespace serialbox

#endif