string.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_STL_STRING_HPP
#define LIBH5_STL_STRING_HPP
 
#include "../group.hpp"
 
#include <string>
#include <vector>
 
namespace h5 {
 
  // Forward declaration.
  template <typename T>
  struct hdf5_format_impl;
 
  template <>
  struct hdf5_format_impl<std::string> {
    static std::string invoke() { return "string"; }
  };
 
  void h5_write(group g, std::string const &name, std::string const &s);
 
  inline void h5_write(group g, std::string const &name, const char *s) { h5_write(g, name, std::string{s}); }
 
  void h5_read(group g, std::string const &name, std::string &s);
 
  inline void h5_read(group g, std::string const &name, char *s) = delete;
 
  void h5_write_attribute(object obj, std::string const &name, std::string const &s);
 
  inline void h5_write_attribute(object obj, std::string const &name, const char *s) { h5_write_attribute(obj, name, std::string{s}); }
 
  void h5_read_attribute(object obj, std::string const &name, std::string &s);
 
  inline void h5_read_attribute(object obj, std::string const &name, char *s) = delete;
 
  void h5_write_attribute_to_key(group g, std::string const &key, std::string const &name, std::string const &s);
 
  inline void h5_write_attribute_to_key(group g, std::string const &key, std::string const &name, const char *s) {
    h5_write_attribute_to_key(g, key, name, std::string{s});
  }
 
  void h5_read_attribute_from_key(group g, std::string const &key, std::string const &name, std::string &s);
 
  struct char_buf {
    std::vector<char> buffer;
 
    v_t lengths;
 
    [[nodiscard]] datatype dtype() const;
 
    [[nodiscard]] dataspace dspace() const;
  };
 
  void h5_write(group g, std::string const &name, char_buf const &cb);
 
  void h5_read(group g, std::string const &name, char_buf &cb);
 
  void h5_write_attribute(object obj, std::string const &name, char_buf const &cb);
 
  void h5_read_attribute(object obj, std::string const &name, char_buf &cb);
 
} // namespace h5
 
#endif // LIBH5_STL_STRING_HPP