deploy: 7c9208bfb3

api/json_pointer/pop_front/index.md

@@ -0,0 +1,58 @@
+# nlohmann::json_pointer::pop_front
+
+```
+void pop_front();
+```
+
+Remove the first reference token.
+
+## Exceptions
+
+Throws [out_of_range.405](https://json.nlohmann.me/home/exceptions/#jsonexceptionout_of_range405) if the JSON pointer has no parent.
+
+## Complexity
+
+Linear in the number of reference tokens in the `json_pointer`.
+
+## Examples
+
+Example
+
+The example shows the usage of `pop_front`.
+
+```
+#include <iostream>
+#include <nlohmann/json.hpp>
+
+using json = nlohmann::json;
+
+int main()
+{
+    // create empty JSON Pointer
+    json::json_pointer ptr("/foo/bar/baz");
+    std::cout << "\"" << ptr << "\"\n";
+
+    // call pop_front()
+    ptr.pop_front();
+    std::cout << "\"" << ptr << "\"\n";
+
+    ptr.pop_front();
+    std::cout << "\"" << ptr << "\"\n";
+
+    ptr.pop_front();
+    std::cout << "\"" << ptr << "\"\n";
+}
+```
+
+Output:
+
+```
+"/foo/bar/baz"
+"/bar/baz"
+"/baz"
+""
+```
+
+## Version history
+
+- Added in version 3.12.x.