file.hpp

Go to the documentation of this file.

// Copyright (c) 2019-2024 Simons Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0.txt
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Authors: Thomas Hahn, Olivier Parcollet, Nils Wentzell

 
#ifndef LIBH5_FILE_HPP
#define LIBH5_FILE_HPP
 
#include "./object.hpp"
 
#include <cstddef>
#include <span>
#include <string>
#include <vector>
 
namespace h5 {

  class file : public object {
    public:
    file();

    file(const char *name, char mode);

    file(std::string const &name, char mode) : file(name.c_str(), mode) {}

    [[nodiscard]] std::string name() const;

    void flush();
 
    private:
    // Constructor to create a buffered memory file with an initial file image of a given size.
    file(const std::byte *buf, size_t size);
 
    public:
    file(std::span<std::byte> const &buf) : file(buf.data(), buf.size()) {}

    file(std::vector<std::byte> const &buf) : file(buf.data(), buf.size()) {}

    [[nodiscard]] std::vector<std::byte> as_buffer() const;
  };
 
} // namespace h5
 
#endif // LIBH5_FILE_HPP