BOOST C++ Filesystem library: заголовочный файл boost/filesystem/exception.hpp

Вступление

Данный хидер содержит объявление класса filesystem_error, публично наследующий от класса std::runtime_error. Он используется функциями в библиотеке Bost.Filesystem для сообщения об ошибках в работе.

Дизайн класса развивается в ответ на требования пользователей облегчить платформонезависимость и интернационализацию приложений. См. руководство обработка ошибок и исключений.

Краткое описание

namespace boost
{
  namespace filesystem
  {
    enum error_code
    {
      no_error = 0,
      system_error,     // system generated error; if possible, is translated
                        // to one of the more specific errors below.
      other_error,      // library generated error
      security_error,   // includes access rights, permissions failures
      read_only_error,
      io_error,
      path_error,
      not_found_error,
      not_directory_error,
      busy_error,       // implies trying again might succeed
      already_exists_error,
      not_empty_error,
      is_directory_error,
      out_of_space_error,
      out_of_memory_error,
      out_of_resource_error
    };

    class filesystem_error : public std::exception
    {
    public:

      filesystem_error( const std::string & who,
        const std::string & message );

      filesystem_error( const std::string & who,
        const path & path1, const std::string & message );

      filesystem_error( const std::string & who,
        const path & path1, sys_err sys_err_code );

      filesystem_error( const std::string & who,
        const path & path1, const path & path2,
        sys_err sys_err_code );

      ~filesystem_error() throw();

      virtual const char * what() const throw();

      sys_err native_error() const;
      error_code error() const;
      const std::string & who() const;
      const path & path1() const;
      const path & path2() const;
    };
  } // namespace filesystem
} // namespace boost

Для POSIX и Windows, sys_err это int. Для других операционных систем этот тип определен реализацией.

Функции-члены

Конструкторы

filesystem_error( const std::string & who,
  const std::string & message );

filesystem_error( const std::string & who,
  const path & path1, const std::string & message );

filesystem_error( const std::string & who,
  const path & path1, int sys_err_code );

filesystem_error( const std::string & who,
  const path & path1, const path & path2,
  int sys_err_code );

Предусловие: Аргумент who должен содержать строку в следующей форме:

boost::filesystem::class-name::function-name для ошибок публичных функций-членов
boost::filesystem::class-name для ошибок, которые не связаны с конкретной функцией-членов.
boost::filesystem::function-name для ошибок не в функциях-членах.

Формы явно определены, чтобы гарантировать платформонезависимость пользовательских программ с разными реализациями библиотеки.

Результаты: создается объект типа filesystem_error.

what

virtual const char * what() const throw();

Возвращает: строку, идентифицирующую ошибку, включая who(), path1(), path2(), и соответствующее сообщение. Если ошибка возникает при подготовке ошибки, в частности из-за нехватки памяти, реализация класса может вернуть указатель на простую статическую строку.

native_error

sys_err native_error() const;

Возвращает: Аргумент конструктора sys_err_code, если таковой был указан, иначе 0.

error

error_code error() const;

Возвращает:: native_error() переведенная в error_code. перевод определяется реализацией. Для реализаций в POSIX и Windows см. libs/filesystem/src/exception.cpp.

who

const std::string & who() const;

Возвращает: Аргумент конструктора who. Реализация может вернуть пустую строку, если в ходе обработки исключения возникает ошибка, к примеру, std::bad_alloc.

path11

const path & path1() const;

Возвращает: Аргумент конструктора path1, если он был указан, иначе path(). Релизация может вернуть пустой путь, если в ходе обработки исключения возникает ошибка, к примеру, std::bad_alloc.

path2

const path & path2() const;

Возвращает: Аргумент конструктора path2, если он есть, иначе path(). Реализация может вернуть пустую строку, если в ходе обработки исключения возникает ошибка, к примеру, std::bad_alloc.

Благодарности

Peter Dimov терпеливо формулировал требования касательно платформнонезависимости и интернационализации сообщений об ошибках.

Revised 25 мая, 2005

Use, modification, and distribution are subject to the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at www.boost.org/LICENSE_1_0.txt)

последняя правка: 24.05.2005

библиотека BOOST C++ http://www.boost.org
перевод Elijah Koziev www.solarix.ru