ls-standard-library/include/ls-std/io/FileReader.hpp

/*
 * Author:          Patrick-Christopher Mattulat
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2020-08-17
 * Changed:         2024-09-13
 *
 * */

#ifndef LS_STD_FILE_READER_HPP
#define LS_STD_FILE_READER_HPP

#include "File.hpp"
#include <ls-std/core/Class.hpp>
#include <ls-std/core/interface/IReader.hpp>
#include <ls-std/os/dynamic-goal.hpp>

/*
 * @doc: class(name: 'FileReader', package: 'io')
 * @doc: io.FileReader.description('This class can read the content of a file and return it as byte field.')
 * */

namespace ls::std::io
{
  class LS_STD_DYNAMIC_GOAL FileReader : public ls::std::core::Class, public ls::std::core::interface_type::IReader
  {
    public:

      explicit FileReader(const ls::std::io::File &_file);
      ~FileReader() noexcept override;

      [[nodiscard]] ls::std::core::type::byte_field read() override;
      void reset(const ls::std::io::File &_file);

    private:

      ls::std::io::File file;
  };
}

#endif