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

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

#ifndef LS_STD_FILE_PATH_SEPARATOR_HPP
#define LS_STD_FILE_PATH_SEPARATOR_HPP

#include <ls-std/os/dynamic-goal.hpp>
#include <string>

/*
 * @doc: class(name: 'FilePathSeparator', package: 'io')
 * @doc: io.FilePathSeparator.description('This class represents the OS specific separator withing file paths on either Windows- or Unix-like operating systems.')
 * */

namespace ls::std::io
{
  class LS_STD_DYNAMIC_GOAL FilePathSeparator
  {
    public:

      FilePathSeparator();
      ~FilePathSeparator();

      [[nodiscard]] static char get();
      [[nodiscard]] static char getUnixFilePathSeparator();
      [[nodiscard]] static char getWindowsFilePathSeparator();
  };
}

#endif