boost/url/error.hpp

0001 //
0002 // Copyright (c) 2019 Vinnie Falco (vinnie.falco@gmail.com)
0003 //
0004 // Distributed under the Boost Software License, Version 1.0. (See accompanying
0005 // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
0006 //
0007 // Official repository: https://github.com/boostorg/url
0008 //
0009
0010 #ifndef BOOST_URL_ERROR_HPP
0011 #define BOOST_URL_ERROR_HPP
0012
0013 #include <boost/url/detail/config.hpp>
0014 #include <boost/url/error_types.hpp>
0015 #include <stdexcept>
0016
0017 namespace boost {
0018 namespace urls {
0019
0020 /** Error codes returned the library
0021 */
0022 enum class error
0023 {
0024     // VFALCO 3 space indent or
0025     // else Doxygen malfunctions
0026
0027     /**
0028      * The operation completed successfully.
0029     */
0030     success = 0,
0031
0032     /**
0033      * Null encountered in pct-encoded.
0034     */
0035     illegal_null,
0036
0037     /**
0038      * Illegal reserved character in encoded string.
0039     */
0040     illegal_reserved_char,
0041
0042     /**
0043      * A grammar element was not in canonical form.
0044     */
0045     non_canonical,
0046
0047     //--------------------------------------------
0048
0049     /**
0050      * Bad hexadecimal digit.
0051
0052        This error condition is fatal.
0053     */
0054     bad_pct_hexdig,
0055
0056     /**
0057      * The percent-encoded sequence is incomplete.
0058
0059        This error condition is fatal.
0060     */
0061     incomplete_encoding,
0062
0063     /**
0064      * Missing hexadecimal digit.
0065
0066        This error condition is fatal.
0067     */
0068     missing_pct_hexdig,
0069
0070     /**
0071      * No space in output buffer
0072
0073        This error is returned when a provided
0074        output buffer was too small to hold
0075        the complete result of an algorithm.
0076     */
0077     no_space,
0078
0079     /**
0080      * The URL is not a base URL
0081     */
0082     not_a_base
0083 };
0084
0085 } // urls
0086 } // boost
0087
0088 #include <boost/url/impl/error.hpp>
0089
0090 #endif