remove.md

jsoncons::jsonpointer::remove

Removes a json element.

#include <jsoncons_ext/jsonpointer/jsonpointer.hpp>

template <typename Json>
void remove(Json& target, 
            const basic_json_pointer<Json::char_type>& location); (1)

template <typename Json>
void remove(Json& target, 
            const basic_json_pointer<Json::char_type>& location, 
            std::error_code& ec);                                 (2)

template <typename Json,typename StringSource>
void remove(Json& target, 
            const StringSource& location_str);                    (3)

template <typename Json,typename StringSource>
void remove(Json& target, 
            const StringSource& location_str, 
            std::error_code& ec);                                 (4)

Removes the value at the location specifed by location.

Parameters

target	JSON value
location	A basic_json_pointer
location_str	A JSON Pointer provided as a string, string view, or C-string
ec	out-parameter for reporting errors in the non-throwing overload

Return value

None

Exceptions

(1) Throws a jsonpointer_error if remove fails.

(2) Sets the out-parameter ec to the jsonpointer_error_category if remove fails.

Examples

Remove an object member

#include <jsoncons/json.hpp>
#include <jsoncons_ext/jsonpointer/jsonpointer.hpp>

namespace jsonpointer = jsoncons::jsonpointer;

int main()
{
    auto target = json::parse(R"(
        { "foo": "bar", "baz" : "qux"}
    )");

    std::error_code ec;
    jsonpointer::remove(target, "/baz", ec);
    if (ec)
    {
        std::cout << ec.message() << std::endl;
    }
    else
    {
        std::cout << target << std::endl;
    }
}

Output:

{"foo":"bar"}

Remove an array element

#include <jsoncons/json.hpp>
#include <jsoncons_ext/jsonpointer/jsonpointer.hpp>

using jsoncons::json;
namespace jsonpointer = jsoncons::jsonpointer;

int main()
{
    auto target = json::parse(R"(
        { "foo": [ "bar", "qux", "baz" ] }
    )");

    std::error_code ec;
    jsonpointer::remove(target, "/foo/1", ec);
    if (ec)
    {
        std::cout << ec.message() << std::endl;
    }
    else
    {
        std::cout << target << std::endl;
    }
}

Output:

{"foo":["bar","baz"]}