Class parse_error

Source/Utils/json.hpp:2424–2471

! @brief exception indicating a parse error This exception is thrown by the library when a parse error occurs. Parse errors can occur during the deserialization of JSON text, CBOR, MessagePack, as well as when using JSON Patch. Member @a byte holds the byte index of the last read character in the input file. Exceptions have ids 1xx.

        @since version 3.0.0
        */
        class parse_error : public exception
        {
        public:
            /*!
            @brief create a parse error exception
            @param[in] id_       the id of the exception
            @param[in] pos       the position where the error occurred (or with
                                 chars_read_total=0 if the position cannot be
                                 determined)
            @param[in] what_arg  the explanatory string
            @return parse_error object
            */
            static parse_error create(int id_, const position_t& pos, const std::string& what_arg)
            {
                std::string w = exception::name("parse_error", id_) + "parse error" +
                    position_string(pos) + ": " + what_arg;
                return parse_error(id_, pos.chars_read_total, w.c_str());
            }

            static parse_error create(int id_, std::size_t byte_, const std::string& what_arg)
            {
                std::string w = exception::name("parse_error", id_) + "parse error" +
                    (byte_ != 0 ? (" at byte " + std::to_string(byte_)) : "") +
                    ": " + what_arg;
                return parse_error(id_, byte_, w.c_str());
            }

            /*!
            @brief byte index of the parse error

            The byte index of the last read character in the input file.

            @note For an input with n bytes, 1 is the index of the first character and
                  n+1 is the index of the terminating null byte or the end of file.
                  This also holds true when reading a byte vector (CBOR or MessagePack).
            */
            const std::size_t byte;

        private:
            parse_error(int id_, std::size_t byte_, const char* what_arg)
                : exception(id_, what_arg), byte(byte_) {}

            static std::string position_string(const position_t& pos)
            {
                return " at line " + std::to_string(pos.lines_read + 1) +
                    ", column " + std::to_string(pos.chars_read_current_line);
            }
        };

        /*!
        @brief exception indicating errors with iterators