| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433 |
- //
- // Copyright (c) 2019 Vinnie Falco (vinnie.falco@gmail.com)
- //
- // Distributed under the Boost Software License, Version 1.0. (See accompanying
- // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
- //
- // Official repository: https://github.com/boostorg/json
- //
- #ifndef BOOST_JSON_OBJECT_HPP
- #define BOOST_JSON_OBJECT_HPP
- #include <boost/json/detail/config.hpp>
- #include <boost/json/detail/object.hpp>
- #include <boost/json/detail/value.hpp>
- #include <boost/json/kind.hpp>
- #include <boost/json/pilfer.hpp>
- #include <boost/system/result.hpp>
- #include <boost/json/storage_ptr.hpp>
- #include <boost/json/string_view.hpp>
- #include <cstdlib>
- #include <initializer_list>
- #include <iterator>
- #include <type_traits>
- #include <utility>
- namespace boost {
- namespace json {
- class value;
- class value_ref;
- class key_value_pair;
- /** A dynamically sized associative container of JSON key/value pairs.
- This is an associative container whose elements are key/value pairs with
- unique keys.
- The elements are stored contiguously; iterators are ordinary pointers,
- allowing random access pointer arithmetic for retrieving elements. In
- addition, the container maintains an internal index to speed up find
- operations, reducing the average complexity for most lookups and
- insertions.
- Reallocations are usually costly operations in terms of performance, as
- elements are copied and the internal index must be rebuilt. The @ref
- reserve function can be used to eliminate reallocations if the number of
- elements is known beforehand.
- @par Allocators
- All elements stored in the container, and their children if any, will use
- the same memory resource that was used to construct the container.
- @par Thread Safety
- Non-const member functions may not be called concurrently with any other
- member functions.
- @par Satisfies
- [ContiguousContainer](https://en.cppreference.com/w/cpp/named_req/ContiguousContainer),
- [ReversibleContainer](https://en.cppreference.com/w/cpp/named_req/ReversibleContainer), and
- {req_SequenceContainer}.
- */
- class object
- {
- struct table;
- class revert_construct;
- class revert_insert;
- friend class value;
- friend class object_test;
- using access = detail::access;
- using index_t = std::uint32_t;
- static index_t constexpr null_index_ =
- std::uint32_t(-1);
- storage_ptr sp_; // must come first
- kind k_ = kind::object; // must come second
- table* t_;
- BOOST_JSON_DECL
- static table empty_;
- template<class T>
- using is_inputit = typename std::enable_if<
- std::is_constructible<key_value_pair,
- typename std::iterator_traits<T>::reference
- >::value>::type;
- BOOST_JSON_DECL
- explicit
- object(detail::unchecked_object&& uo);
- public:
- /// Associated [Allocator](https://en.cppreference.com/w/cpp/named_req/Allocator)
- using allocator_type = container::pmr::polymorphic_allocator<value>;
- /** The type of keys.
- The function @ref string::max_size returns the
- maximum allowed size of strings used as keys.
- */
- using key_type = string_view;
- /// The type of mapped values
- using mapped_type = value;
- /// The element type
- using value_type = key_value_pair;
- /// The type used to represent unsigned integers
- using size_type = std::size_t;
- /// The type used to represent signed integers
- using difference_type = std::ptrdiff_t;
- /// A reference to an element
- using reference = value_type&;
- /// A const reference to an element
- using const_reference = value_type const&;
- /// A pointer to an element
- using pointer = value_type*;
- /// A const pointer to an element
- using const_pointer = value_type const*;
- /// A random access iterator to an element
- using iterator = value_type*;
- /// A const random access iterator to an element
- using const_iterator = value_type const*;
- /// A reverse random access iterator to an element
- using reverse_iterator =
- std::reverse_iterator<iterator>;
- /// A const reverse random access iterator to an element
- using const_reverse_iterator =
- std::reverse_iterator<const_iterator>;
- //------------------------------------------------------
- /** Destructor.
- The destructor for each element is called if needed, any used memory is
- deallocated, and shared ownership of the
- @ref boost::container::pmr::memory_resource is released.
- @par Complexity
- Constant, or linear in @ref size().
- @par Exception Safety
- No-throw guarantee.
- */
- BOOST_JSON_DECL
- ~object() noexcept;
- //------------------------------------------------------
- /** Constructors.
- Constructs an object.
- @li **(1)**--**(3)** the object is empty.
- @li **(4)** the object is filled with values in the range
- `[first, last)`.
- @li **(5)**, **(6)** the object is filled with copies of the values in
- `init`.
- @li **(7)**, **(8)** the object is filled with copies of the elements
- of `other`.
- @li **(9)** the object acquires ownership of the contents of `other`.
- @li **(10)** equivalent to **(9)** if `*sp == *other.storage()`;
- otherwise equivalent to **(8)**.
- @li **(11)** the object acquires ownership of the contents of `other`
- using pilfer semantics. This is more efficient than move
- construction, when it is known that the moved-from object will be
- immediately destroyed afterwards.
- Upon construction, @ref capacity() will be large enough to store the
- object's elements. In addition, with **(3)**, **(4)**, and **(6)** the
- capacity will not be smaller than `min_capacity`.
- With **(2)**--**(6)**, **(8)**, **(10)** the constructed object uses
- memory resource of `sp`. With **(7)**, **(9)**, **(11)** it uses
- `other`'s memory resource. In either case the object will share the
- ownership of the memory resource. With **(1)** it uses the
- \<\<default_memory_resource,default memory resource\>\>.
- After **(9)** `other` behaves as if newly constructed with its current
- storage pointer.
- After **(11)** `other` is not in a usable state and may only be
- destroyed.
- If `init` or `[first, last)` have elements with duplicate keys, only
- the first of those equivalent elements will be inserted.
- @par Constraints
- @code
- std::is_constructible_v<
- key_value_pair,
- std::iterator_traits<InputIt>::reference>
- @endcode
- @par Complexity
- @li **(1)**--**(3)**, **(9)**, **(11)** constant.
- @li **(4)** linear in `std::distance(first, last)`.
- @li **(5)**, **(6)** linear in `init.size()`.
- @li **(7)**, **(8)** linear in `other.size()`.
- @li **(10)** constant if `*sp == *other.storage()`; otherwise linear in
- `other.size()`.
- @par Exception Safety
- @li **(1)**, **(2)**, **(9)**, **(11)** no-throw guarantee.
- @li **(3)**, **(5)**, **(6)**--**(8)**, **(10)** strong guarantee.
- @li **(4)** strong guarantee if `InputIt` satisfies
- {req_ForwardIterator}, basic guarantee otherwise.
- Calls to `memory_resource::allocate` may throw.
- @see @ref pilfer,
- [Valueless Variants Considered Harmful](http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2016/p0308r0.html).
- @{
- */
- object() noexcept
- : t_(&empty_)
- {
- }
- /** Overload
- @param sp A pointer to the @ref boost::container::pmr::memory_resource
- to use.
- */
- explicit
- object(storage_ptr sp) noexcept
- : sp_(std::move(sp))
- , t_(&empty_)
- {
- }
- /** Overload
- @param min_capacity The minimum number of elements for which capacity
- is guaranteed without a subsequent reallocation.
- @param sp
- */
- BOOST_JSON_DECL
- object(
- std::size_t min_capacity,
- storage_ptr sp = {});
- /** Overload
- @param first An input iterator pointing to the first element to insert,
- or pointing to the end of the range.
- @param last An input iterator pointing to the end of the range.
- @param min_capacity
- @param sp
- @tparam InputIt a type satisfying the requirements of
- {req_InputIterator}.
- */
- template<
- class InputIt
- #ifndef BOOST_JSON_DOCS
- ,class = is_inputit<InputIt>
- #endif
- >
- object(
- InputIt first,
- InputIt last,
- std::size_t min_capacity = 0,
- storage_ptr sp = {})
- : sp_(std::move(sp))
- , t_(&empty_)
- {
- construct(
- first, last,
- min_capacity,
- typename std::iterator_traits<
- InputIt>::iterator_category{});
- }
- /** Overload
- @param init The initializer list to insert.
- @param sp
- */
- object(
- std::initializer_list<
- std::pair<string_view, value_ref>> init,
- storage_ptr sp = {})
- : object(init, 0, std::move(sp))
- {
- }
- /** Overload
- @param init
- @param min_capacity
- @param sp
- */
- BOOST_JSON_DECL
- object(
- std::initializer_list<
- std::pair<string_view, value_ref>> init,
- std::size_t min_capacity,
- storage_ptr sp = {});
- /** Overload
- @param other Another object.
- */
- object(
- object const& other)
- : object(other, other.sp_)
- {
- }
- /** Overload
- @param other
- @param sp
- */
- BOOST_JSON_DECL
- object(
- object const& other,
- storage_ptr sp);
- /** Overload
- @param other
- */
- BOOST_JSON_DECL
- object(object&& other) noexcept;
- /** Overload
- @param other
- @param sp
- */
- BOOST_JSON_DECL
- object(
- object&& other,
- storage_ptr sp);
- /** Overload
- @param other
- */
- object(pilfered<object> other) noexcept
- : sp_(std::move(other.get().sp_))
- , t_(detail::exchange(
- other.get().t_, &empty_))
- {
- }
- /// @}
- //------------------------------------------------------
- //
- // Assignment
- //
- //------------------------------------------------------
- /** Assignment operators.
- Replaces the contents of this object.
- @li **(1)** replaces with the copies of the elements of `other`.
- @li **(2)** takes ownership of `other`'s element storage if
- `*storage() == *other.storage()`; otherwise equivalent to **(1)**.
- @li **(3)** replaces with the elements of `init`.
- @par Complexity
- @li **(1)** linear in `size() + other.size()`.
- @li **(2)** constant if `*storage() == *other.storage()`; otherwise
- linear in `size() + other.size()`.
- @li **(3)** average case linear in `size() + init.size()`, worst case
- quadratic in `init.size()`.
- @par Exception Safety
- @li **(1)**, **(3)** strong guarantee.
- @li **(2)** no-throw guarantee if `*storage() == *other.storage()`;
- otherwise strong guarantee.
- Calls to `memory_resource::allocate` may throw.
- @par Complexity
- @param other Another object.
- @{
- */
- BOOST_JSON_DECL
- object&
- operator=(object const& other);
- BOOST_JSON_DECL
- object&
- operator=(object&& other);
- /** Overload
- @param init The initializer list to copy.
- */
- BOOST_JSON_DECL
- object&
- operator=(std::initializer_list<
- std::pair<string_view, value_ref>> init);
- /// @}
- //------------------------------------------------------
- /** Return the associated memory resource.
- This function returns a smart pointer to the
- @ref boost::container::pmr::memory_resource used by the container.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- storage_ptr const&
- storage() const noexcept
- {
- return sp_;
- }
- /** Return the associated allocator.
- This function returns an instance of @ref allocator_type constructed
- from the associated @ref boost::container::pmr::memory_resource.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- allocator_type
- get_allocator() const noexcept
- {
- return sp_.get();
- }
- //------------------------------------------------------
- //
- // Iterators
- //
- //------------------------------------------------------
- /** Return an iterator to the first element.
- If the container is empty, @ref end() is returned.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- inline
- iterator
- begin() noexcept;
- inline
- const_iterator
- begin() const noexcept;
- /// @}
- /** Return a const iterator to the first element.
- If the container is empty, @ref cend() is returned.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- inline
- const_iterator
- cbegin() const noexcept;
- /** Return an iterator to the element following the last element.
- The element acts as a placeholder; attempting
- to access it results in undefined behavior.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- inline
- iterator
- end() noexcept;
- inline
- const_iterator
- end() const noexcept;
- /// @}
- /** Return a const iterator to the element following the last element.
- The element acts as a placeholder; attempting
- to access it results in undefined behavior.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- inline
- const_iterator
- cend() const noexcept;
- /** Return a reverse iterator to the first element of the reversed container.
- The pointed-to element corresponds to the last element of the
- non-reversed container. If the container is empty, @ref rend() is
- returned.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- inline
- reverse_iterator
- rbegin() noexcept;
- inline
- const_reverse_iterator
- rbegin() const noexcept;
- /// @}
- /** Return a const reverse iterator to the first element of the reversed container.
- The pointed-to element corresponds to the
- last element of the non-reversed container.
- If the container is empty, @ref crend() is returned.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- inline
- const_reverse_iterator
- crbegin() const noexcept;
- /** Return a reverse iterator to the element following the last element of the reversed container.
- The pointed-to element corresponds to the element preceding the first
- element of the non-reversed container. The returned iterator only acts
- as a sentinel. Dereferencing it results in undefined behavior.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- inline
- reverse_iterator
- rend() noexcept;
- inline
- const_reverse_iterator
- rend() const noexcept;
- /// @}
- /** Return a const reverse iterator to the element following the last element of the reversed container.
- The pointed-to element corresponds to the element preceding the first
- element of the non-reversed container. The returned iterator only acts
- as a sentinel. Dereferencing it results in undefined behavior.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- inline
- const_reverse_iterator
- crend() const noexcept;
- //------------------------------------------------------
- //
- // Capacity
- //
- //------------------------------------------------------
- /** Return whether there are no elements.
- Returns `true` if there are no elements in
- the container, i.e. @ref size() returns 0.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- inline
- bool
- empty() const noexcept;
- /** Return the number of elements.
- This returns the number of elements in the container.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- inline
- std::size_t
- size() const noexcept;
- /** The maximum number of elements an object can hold.
- The maximum is an implementation-defined number dependent on system or
- library implementation. This value is a theoretical limit; at runtime,
- the actual maximum size may be less due to resource limits.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- static
- constexpr
- std::size_t
- max_size() noexcept;
- /** Return the number of elements that can be held in currently allocated memory.
- Returns the number of elements that the container has currently
- allocated space for. This number is never smaller than the value
- returned by @ref size().
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- inline
- std::size_t
- capacity() const noexcept;
- /** Increase the capacity to at least a certain amount.
- This increases the @ref capacity() to a value that is greater than or
- equal to `new_capacity`. If `new_capacity > capacity()`, new memory is
- allocated. Otherwise, the call has no effect. The number of elements
- and therefore the @ref size() of the container is not changed.
- If new memory is allocated, all iterators including any past-the-end
- iterators, and all references to the elements are invalidated.
- Otherwise, no iterators or references are invalidated.
- @par Complexity
- Constant if no reallocation occurs. Otherwise, average case linear in
- @ref size(), worst case quadratic in @ref size().
- @par Exception Safety
- Strong guarantee. Calls to `memory_resource::allocate` may throw.
- @param new_capacity The new minimum capacity.
- @throw boost::system::system_error `new_capacity >` @ref max_size().
- */
- inline
- void
- reserve(std::size_t new_capacity);
- //------------------------------------------------------
- //
- // Modifiers
- //
- //------------------------------------------------------
- /** Erase all elements.
- Erases all elements from the container. After this call, @ref size()
- returns zero but @ref capacity() is unchanged. All references,
- pointers, and iterators are invalidated.
- @par Complexity
- Linear in @ref size().
- @par Exception Safety
- No-throw guarantee.
- */
- BOOST_JSON_DECL
- void
- clear() noexcept;
- /** Insert elements.
- @li **(1)** inserts a new element constructed as if via
- `value_type( std::forward<P>(p) )`.
- @li **(2)** the elements in the range `[first, last)` are inserted one
- at a time, in order.
- @li **(3)** the elements in the initializer list are inserted one at a
- time, in order.
- Any element with key that is a duplicate of a key already present in
- container will be skipped. This also means, that if there are two keys
- within the inserted range that are equal to each other, only the
- first will be inserted.
- If an insertion would result in the new number of elements exceeding
- @ref capacity(), a reallocation and a rehashing occur. In that case all
- iterators and references are invalidated. Otherwise, they are not
- affected.
- @pre
- `first` and `last` are not iterators into `*this`. `first` and `last`
- form a valid range.
- @par Constraints
- @code
- std::is_constructible_v<value_type, P>
- std::is_constructible_v<value_type, std::iterator_traits<InputIt>::reference>
- @endcode
- @par Complexity
- @li **(1)** constant on average, worst case linear in @ref size().
- @li **(2)** linear in `std::distance(first, last)`.
- @li **(3)** linear in `init.size()`.
- @par Exception Safety
- @li **(1)** strong guarantee.
- @li **(2)** strong guarantee if `InputIt` satisfies
- {req_ForwardIterator}, basic guarantee otherwise.
- @li **(3)** basic guarantee.
- Calls to `memory_resource::allocate` may throw.
- @param p The value to insert.
- @throw boost::system::system_error The size of a key would exceed
- @ref string::max_size.
- @throw `boost::system::system_error` @ref size() >= @ref max_size().
- @return **(1)** returns a @ref std::pair where `first` is an iterator
- to the existing or inserted element, and `second` is `true` if the
- insertion took place or `false` otherwise. **(2)** returns `void`.
- @{
- */
- template<class P
- #ifndef BOOST_JSON_DOCS
- ,class = typename std::enable_if<
- std::is_constructible<key_value_pair,
- P, storage_ptr>::value>::type
- #endif
- >
- std::pair<iterator, bool>
- insert(P&& p);
- /** Overload
- @param first An input iterator pointing to the first element to insert,
- or pointing to the end of the range.
- @param last An input iterator pointing to the end of the range.
- @tparam InputIt a type satisfying the requirements
- of {req_InputIterator}.
- */
- template<
- class InputIt
- #ifndef BOOST_JSON_DOCS
- ,class = is_inputit<InputIt>
- #endif
- >
- void
- insert(InputIt first, InputIt last)
- {
- insert(first, last, typename
- std::iterator_traits<InputIt
- >::iterator_category{});
- }
- /** Overload
- @param init The initializer list to insert.
- */
- BOOST_JSON_DECL
- void
- insert(std::initializer_list<
- std::pair<string_view, value_ref>> init);
- /// @}
- /** Insert an element or assign to an existing element.
- If the key equal to `key` already exists in the container, assigns
- `std::forward<M>(m)` to the @ref mapped_type corresponding to that key.
- Otherwise, inserts the as if by @ref insert, constructing it using
- `value_type(key, std::forward<M>(m))`.
- If insertion would result in the new number of elements exceeding
- @ref capacity(), a reallocation and a rehashing occur. In that case all
- iterators and references are invalidated. Otherwise, they are not
- affected.
- @par Complexity
- Constant on average, worst case linear in @ref size().
- @par Exception Safety
- Strong guarantee. Calls to `memory_resource::allocate` may throw.
- @return A @ref std::pair where `first` is an iterator to the existing
- or inserted element, and `second` is `true` if the insertion took place
- or `false` if the assignment took place.
- @param key The key used for lookup and insertion.
- @param m The value to insert or assign.
- @throw boost::system::system_error The size of a key would exceed
- @ref string::max_size.
- */
- template<class M>
- std::pair<iterator, bool>
- insert_or_assign(
- string_view key, M&& m);
- /** Construct an element in-place.
- Inserts a new element into the container constructed
- in-place with the given argument if there is no
- element with the `key` in the container.
- If the insertion occurs and results in a rehashing of the container,
- all iterators and references are invalidated. Otherwise, they are not
- affected. Rehashing occurs only if the new number of elements is
- greater than @ref capacity().
- @par Complexity
- Constant on average, worst case linear in @ref size().
- @par Exception Safety
- Strong guarantee.
- Calls to `memory_resource::allocate` may throw.
- @return A @ref std::pair where `first` is an iterator
- to the existing or inserted element, and `second`
- is `true` if the insertion took place or `false` otherwise.
- @param key The key used for lookup and insertion.
- @param arg The argument used to construct the value.
- This will be passed as `std::forward<Arg>(arg)` to
- the @ref value constructor.
- @throw boost::system::system_error The size of the key would exceed
- @ref string::max_size.
- */
- template<class Arg>
- std::pair<iterator, bool>
- emplace(string_view key, Arg&& arg);
- /** Remove an element.
- @li **(1)** the element at `pos` is removed.
- @li **(2)** the element with the key `key` is removed, if it exists.
- `pos` must be valid and dereferenceable. References and iterators to
- the erased element are invalidated. Other iterators and references are
- not invalidated.
- @attention The @ref end() iterator (which is valid but cannot be
- dereferenced) cannot be used as a value for `pos`.
- @par Complexity
- Constant on average, worst case linear in @ref size().
- @par Exception Safety
- No-throw guarantee.
- @return
- @li **(1)** an iterator following the removed element.
- @li **(2)** the number of elements removed, which will be either
- 0 or 1.
- @param pos An iterator pointing to the element to be removed.
- @{
- */
- BOOST_JSON_DECL
- iterator
- erase(const_iterator pos) noexcept;
- /** Overload
- @param key The key to match.
- */
- BOOST_JSON_DECL
- std::size_t
- erase(string_view key) noexcept;
- /// @}
- /** Erase an element preserving order.
- @li **(1)** Remove the element pointed to by `pos`, which must be valid
- and dereferenceable. References and iterators from `pos` to @ref end(),
- both included, are invalidated. Other iterators and references are not
- invalidated.
- @li **(2)** Remove the element which matches `key`, if it exists. All
- references and iterators are invalidated.
- The relative order of remaining elements is preserved.
- @attention The @ref end() iterator (which is valid but cannot be
- dereferenced) cannot be used as a value for `pos`.
- @par Complexity
- Linear in @ref size().
- @par Exception Safety
- No-throw guarantee.
- @return
- @li An iterator following the removed element.
- @li The number of elements removed, which will be either 0 or 1.
- @param pos An iterator pointing to the element to be
- removed.
- @{
- */
- BOOST_JSON_DECL
- iterator
- stable_erase(const_iterator pos) noexcept;
- /** Overload
- @param key The key to match.
- */
- BOOST_JSON_DECL
- std::size_t
- stable_erase(string_view key) noexcept;
- /// @}
- /** Swap two objects.
- Exchanges the contents of this object with another object. Ownership of
- the respective @ref boost::container::pmr::memory_resource objects is
- not transferred. If `this == &other`, this function call has no effect.
- @li If `*storage() == *other.storage()` all iterators and references
- remain valid.
- @li Otherwise, the contents are logically swapped by making copies,
- which can throw. In this case all iterators and references are
- invalidated.
- @par Complexity
- If `*storage() == *other.storage()`, then constant; otherwise linear in
- `size() + other.size()`.
- @par Exception Safety
- No-throw guarantee if `*storage() == *other.storage()`. Otherwise
- strong guarantee. Calls to `memory_resource::allocate` may throw.
- @param other The object to swap with.
- */
- BOOST_JSON_DECL
- void
- swap(object& other);
- /** Swap two objects.
- Exchanges the contents of the object `lhs` with another object `rhs`.
- Ownership of the respective @ref boost::container::pmr::memory_resource
- objects is not transferred. If `&lhs == &rhs`, this function call has
- no effect.
- @li If `*lhs.storage() == *rhs.storage()` all iterators and references
- remain valid.
- @li Otherwise, the contents are logically swapped by making copies,
- which can throw. In this case all iterators and references are
- invalidated.
- @par Complexity
- If `*lhs.storage() == *rhs.storage()`, then constant; otherwise linear
- in `lhs.size() + rhs.size()`.
- @par Exception Safety
- No-throw guarantee if `*lhs.storage() == *rhs.storage()`. Otherwise
- strong guarantee. Calls to `memory_resource::allocate` may throw.
- @param lhs The object to exchange.
- @param rhs The object to exchange.
- @see @ref object::swap
- */
- friend
- void
- swap(object& lhs, object& rhs)
- {
- lhs.swap(rhs);
- }
- //------------------------------------------------------
- //
- // Lookup
- //
- //------------------------------------------------------
- /** Access the specified element, with bounds checking.
- Returns @ref boost::system::result containing a reference to the
- mapped value of the element that matches `key`. Otherwise the result
- contains an `error_code`.
- @par Exception Safety
- No-throw guarantee.
- @param key The key of the element to find.
- @par Complexity
- Constant on average, worst case linear in @ref size().
- @{
- */
- BOOST_JSON_DECL
- system::result<value&>
- try_at(string_view key) noexcept;
- BOOST_JSON_DECL
- system::result<value const&>
- try_at(string_view key) const noexcept;
- /// @}
- /** Access the specified element, with bounds checking.
- Returns a reference to the mapped value of the element that matches
- `key`, otherwise throws.
- @par Complexity
- Constant on average, worst case linear in @ref size().
- @par Exception Safety
- Strong guarantee.
- @return A reference to the mapped value.
- @param key The key of the element to find.
- @param loc @ref boost::source_location to use in thrown exception; the
- source location of the call site by default.
- @throw `boost::system::system_error` if no such element exists.
- @see @ref operator[], @ref try_at.
- @{
- */
- inline
- value&
- at(
- string_view key,
- source_location const& loc = BOOST_CURRENT_LOCATION) &;
- inline
- value&&
- at(
- string_view key,
- source_location const& loc = BOOST_CURRENT_LOCATION) &&;
- BOOST_JSON_DECL
- value const&
- at(
- string_view key,
- source_location const& loc = BOOST_CURRENT_LOCATION) const&;
- /// @}
- /** Access or insert an element.
- Returns a reference to the value that is mapped to `key`. If such value
- does not already exist, performs an insertion of a null value.
- If an insertion occurs and results in a rehashing of the container, all
- iterators including any past-the-end iterators, and all references to
- the elements are invalidated. Otherwise, no iterators or references are
- invalidated.
- @par Complexity
- Constant on average, worst case linear in @ref size().
- @par Exception Safety
- Strong guarantee. Calls to `memory_resource::allocate` may throw.
- @return A reference to the mapped value.
- @param key The key of the element to find.
- */
- BOOST_JSON_DECL
- value&
- operator[](string_view key);
- /** Count the number of elements with a specific key.
- Returns the number of elements with keys equal to `key`. The only
- possible return values are 0 and 1.
- @par Complexity
- Constant on average, worst case linear in @ref size().
- @par Exception Safety
- No-throw guarantee.
- @param key The key of the element to find.
- */
- BOOST_JSON_DECL
- std::size_t
- count(string_view key) const noexcept;
- /** Find an element with a specific key.
- This function returns an iterator to the element
- matching `key` if it exists, otherwise returns
- @ref end().
- @par Complexity
- Constant on average, worst case linear in @ref size().
- @par Exception Safety
- No-throw guarantee.
- @param key The key of the element to find.
- @{
- */
- BOOST_JSON_DECL
- iterator
- find(string_view key) noexcept;
- BOOST_JSON_DECL
- const_iterator
- find(string_view key) const noexcept;
- /// @}
- /** Return `true` if the key is found.
- Checks if there is an element with key equal to `key`.
- @par Effects
- @code
- return find(key) != end();
- @endcode
- @par Complexity
- Constant on average, worst case linear in @ref size().
- @par Exception Safety
- No-throw guarantee.
- @param key The key of the element to find.
- @see @ref find.
- */
- BOOST_JSON_DECL
- bool
- contains(string_view key) const noexcept;
- /** Return a pointer to the value if the key is found, or null
- This function searches for a value with the given
- key, and returns a pointer to it if found. Otherwise
- it returns null.
- @par Example
- @code
- if( auto p = obj.if_contains( "key" ) )
- std::cout << *p;
- @endcode
- @par Complexity
- Constant on average, worst case linear in @ref size().
- @par Exception Safety
- No-throw guarantee.
- @param key The key of the element to find.
- @see @ref find.
- @{
- */
- BOOST_JSON_DECL
- value const*
- if_contains(string_view key) const noexcept;
- BOOST_JSON_DECL
- value*
- if_contains(string_view key) noexcept;
- /// @}
- /** Compare two objects for equality.
- Objects are equal when their sizes are the same,
- and when for each key in `lhs` there is a matching
- key in `rhs` with the same value.
- @par Complexity
- Average case linear and worst case quadratic in `lhs.size()`.
- @par Exception Safety
- No-throw guarantee.
- */
- // inline friend speeds up overload resolution
- friend
- bool
- operator==(
- object const& lhs,
- object const& rhs) noexcept
- {
- return lhs.equal(rhs);
- }
- /** Compare two objects for inequality.
- Objects are equal when their sizes are the same, and when for each key
- in `lhs` there is a matching key in `rhs` with the same value.
- @par Complexity
- Average casee linear and worst case quadratic in `lhs.size()`.
- @par Exception Safety
- No-throw guarantee.
- */
- // inline friend speeds up overload resolution
- friend
- bool
- operator!=(
- object const& lhs,
- object const& rhs) noexcept
- {
- return ! (lhs == rhs);
- }
- /** Serialize to an output stream.
- This function serializes an `object` as JSON into the output stream.
- @return Reference to `os`.
- @par Complexity
- Constant or linear in the size of `obj`.
- @par Exception Safety
- Strong guarantee.
- Calls to `memory_resource::allocate` may throw.
- @param os The output stream to serialize to.
- @param obj The value to serialize.
- */
- BOOST_JSON_DECL
- friend
- std::ostream&
- operator<<(
- std::ostream& os,
- object const& obj);
- private:
- #ifndef BOOST_JSON_DOCS
- // VFALCO friending a detail function makes it public
- template<class CharRange>
- friend
- std::pair<key_value_pair*, std::size_t>
- detail::find_in_object(
- object const& obj,
- CharRange key) noexcept;
- #endif
- template<class InputIt>
- void
- construct(
- InputIt first,
- InputIt last,
- std::size_t min_capacity,
- std::input_iterator_tag);
- template<class InputIt>
- void
- construct(
- InputIt first,
- InputIt last,
- std::size_t min_capacity,
- std::forward_iterator_tag);
- template<class InputIt>
- void
- insert(
- InputIt first,
- InputIt last,
- std::input_iterator_tag);
- template<class InputIt>
- void
- insert(
- InputIt first,
- InputIt last,
- std::forward_iterator_tag);
- template< class... Args >
- std::pair<iterator, bool>
- emplace_impl(string_view key, Args&& ... args );
- BOOST_JSON_DECL
- key_value_pair*
- insert_impl(
- pilfered<key_value_pair> p,
- std::size_t hash);
- BOOST_JSON_DECL
- table*
- reserve_impl(std::size_t new_capacity);
- BOOST_JSON_DECL
- bool
- equal(object const& other) const noexcept;
- inline
- std::size_t
- growth(
- std::size_t new_size) const;
- inline
- void
- remove(
- index_t& head,
- key_value_pair& p) noexcept;
- inline
- void
- destroy() noexcept;
- inline
- void
- destroy(
- key_value_pair* first,
- key_value_pair* last) noexcept;
- template<class FS, class FB>
- auto
- do_erase(
- const_iterator pos,
- FS small_reloc,
- FB big_reloc) noexcept
- -> iterator;
- inline
- void
- reindex_relocate(
- key_value_pair* src,
- key_value_pair* dst) noexcept;
- };
- } // namespace json
- } // namespace boost
- #ifndef BOOST_JSON_DOCS
- // boost::hash trait
- namespace boost
- {
- namespace container_hash
- {
- template< class T > struct is_unordered_range;
- template<>
- struct is_unordered_range< json::object >
- : std::true_type
- {};
- } // namespace container_hash
- } // namespace boost
- // std::hash specialization
- namespace std {
- template <>
- struct hash< ::boost::json::object > {
- BOOST_JSON_DECL
- std::size_t
- operator()(::boost::json::object const& jo) const noexcept;
- };
- } // std
- #endif
- // Must be included here for this file to stand alone
- #include <boost/json/value.hpp>
- // includes are at the bottom of <boost/json/value.hpp>
- #endif
|