| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824 |
- //
- // Copyright (c) 2019 Vinnie Falco (vinnie.falco@gmail.com)
- // Copyright (c) 2020 Krystian Stasiowski (sdkrystian@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_VALUE_HPP
- #define BOOST_JSON_VALUE_HPP
- #include <boost/core/detail/static_assert.hpp>
- #include <boost/json/detail/config.hpp>
- #include <boost/json/array.hpp>
- #include <boost/json/kind.hpp>
- #include <boost/json/object.hpp>
- #include <boost/json/pilfer.hpp>
- #include <boost/json/set_pointer_options.hpp>
- #include <boost/json/storage_ptr.hpp>
- #include <boost/json/string.hpp>
- #include <boost/json/string_view.hpp>
- #include <boost/json/value_ref.hpp>
- #include <boost/json/detail/except.hpp>
- #include <boost/json/detail/value.hpp>
- #include <cstdlib>
- #include <cstring>
- #include <initializer_list>
- #include <iosfwd>
- #include <limits>
- #include <new>
- #include <type_traits>
- #include <utility>
- namespace boost {
- namespace json {
- //----------------------------------------------------------
- /** The type used to represent any JSON value
- This is a [Regular](https://en.cppreference.com/w/cpp/concepts/regular)
- type which works like a variant of the basic JSON data types: array,
- object, string, number, boolean, and null.
- @par Thread Safety
- Distinct instances may be accessed concurrently. Non-const member
- functions of a shared instance may not be called concurrently with any
- other member functions of that instance.
- */
- class value
- {
- #ifndef BOOST_JSON_DOCS
- using scalar = detail::scalar;
- union
- {
- storage_ptr sp_; // must come first
- array arr_;
- object obj_;
- string str_;
- scalar sca_;
- };
- #endif
- struct init_iter;
- #ifndef BOOST_JSON_DOCS
- // VFALCO doc toolchain incorrectly treats this as public
- friend struct detail::access;
- #endif
- explicit
- value(
- detail::unchecked_array&& ua)
- : arr_(std::move(ua))
- {
- }
- explicit
- value(
- detail::unchecked_object&& uo)
- : obj_(std::move(uo))
- {
- }
- value(
- detail::key_t const&,
- string_view s,
- storage_ptr sp)
- : str_(detail::key_t{}, s, std::move(sp))
- {
- }
- value(
- detail::key_t const&,
- string_view s1,
- string_view s2,
- storage_ptr sp)
- : str_(detail::key_t{}, s1, s2, std::move(sp))
- {
- }
- inline bool is_scalar() const noexcept
- {
- return sca_.k < json::kind::string;
- }
- public:
- /// Associated [Allocator](https://en.cppreference.com/w/cpp/named_req/Allocator)
- using allocator_type = container::pmr::polymorphic_allocator<value>;
- /** Destructor.
- The value and all of its contents are destroyed. Any dynamically
- allocated memory that was allocated internally is freed.
- @par Complexity
- Constant, or linear in size for array or object.
- @par Exception Safety
- No-throw guarantee.
- */
- BOOST_JSON_DECL
- ~value() noexcept;
- /** Constructors.
- Construct a new `value`.
- @li **(1)**--**(3)** the constructed value is null.
- @li **(4)** the constructed value contains a copy of `b`.
- @li **(5)**--**(9)** the constructed value contains a copy of `i`.
- @li **(10)**--**(14)** the constructed value contains a copy of `u`.
- @li **(15)** the constructed value contains a copy of `d`.
- @li **(16)**, **(19)** the constructed value contains a copy of the
- string `s`.
- @li **(17)** the constructed value contains a copy of the
- null-terminated string `s`.
- @li **(18)** the constructed value takes ownership of `s`'s storage.
- @li **(20)** if `*s.storage() == *sp` equivalent to **(18)**, otherwise
- equivalent to **(19)**.
- @li **(21)** the constructed value contains an empty string.
- @li **(22)** the constructed value takes ownership of `arr`'s storage.
- @li **(23)** the constructed value contains an element-wise copy of the
- array `arr`.
- @li **(24)** if `*arr.storage() == *sp` equivalent to **(22)**,
- otherwise equivalent to **(23)**.
- @li **(25)** the constructed value contains an empty array.
- @li **(26)** the constructed value takes ownership of `obj`'s storage.
- @li **(27)** the constructed value contains an element-wise copy of the
- object `obj`.
- @li **(28)** if `*obj.storage() == *sp` equivalent to **(26)**,
- otherwise equivalent to **(27)**.
- @li **(29)** the constructed value contains an empty object.
- @li **(30)** the constructed value's contents are formed by
- constructing from `init` and `sp` (see \<\<initializer_lists\>\>).
- @li **(31)**, **(32)** the constructed value contains a copy of the
- contents of `other`.
- @li **(33)** the constructed value acquires ownership of the contents
- of `other`.
- @li **(34)** equivalent to **(33)** if `*sp == *other.storage()`;
- otherwise equivalent to **(32)**.
- @li **(35)** the constructed value 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.
- With **(2)**--**(17)**, **(19)**--**(21)**, **(23)**--**(25)**,
- {sp} **(27)**--**(30)**, **(32)**, and **(34)** the constructed value
- uses memory resource of `sp`. With **(18)**, **(22)**, **(26)**,
- {sp} **(31)**, **(33)**, and **(35)** it uses the memory resource of
- the argument (`s`, `arr`, obj`, or `value`). In either case the value
- will share the ownership of the memory resource. With **(1)**
- it uses the \<\<default_memory_resource, default memory resource\>\>.
- After **(18)**, **(22)**, **(26)**, and **(33)** the argument behaves
- as if newly constructed with its current storage pointer (i.e. becomes
- an empty string, array, object, or null value).
- After **(35)** `other` is not in a usable state and may only be
- destroyed.
- @par Complexity
- @li **(1)**--**(15)**, **(18)**, **(21)**, **(22)**, **(25)**,
- {sp} **(26)**, **(29)**, **(33)**, **(35)** constant.
- @li **(16)**, **(19)** linear in `s.size()`.
- @li **(17)** linear in `std::strlen(s)`.
- @li **(20)** if `*s.storage() == *sp` constant, otherwise linear
- in `s.size()`.
- @li **(23)** linear in `arr.size()`.
- @li **(24)** if `*arr.storage() == *sp` constant, otherwise linear
- in `arr.size()`.
- @li **(27)** linear in `obj.size()`.
- @li **(28)** if `*obj.storage() == *sp` constant, otherwise linear
- in `obj.size()`.
- @li **(30)** linear in `init.size()`.
- @li **(31)**, **(32)** linear in the size of `other`.
- @li **(34)** constant if `*sp == *other.storage()`; otherwise linear in
- the size of `other`.
- The size of `other` is either the size of the underlying container
- (if there is one), or can be considered to be 1.
- @par Exception Safety
- @li **(1)**--**(15)**, **(18)**, **(21)**, **(22)**, **(25)**,
- **(26)**, **(29)**, **(33)**, **(35)** no-throw guarantee.
- @li **(16)**, **(17)**, **(19)**, **(23)**, **(27)**,
- **(30)**--**(32)** strong guarantee.
- @li **(20)** if `*s.storage() == *sp` no-throw guarantee, otherwise
- strong guarantee.
- @li **(24)** if `*arr.storage() == *sp` no-throw guarantee, otherwise
- strong guarantee.
- @li **(28)** if `*obj.storage() == *sp` no-throw guarantee, otherwise
- strong guarantee.
- @li **(33)** if `*other.storage() == *sp` no-throw guarantee, otherwise
- strong guarantee.
- 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).
- //
- @{
- */
- value() noexcept
- : sca_()
- {
- }
- /** Overload
- @param sp A pointer to the @ref boost::container::pmr::memory_resource
- to use.
- */
- explicit
- value(storage_ptr sp) noexcept
- : sca_(std::move(sp))
- {
- }
- /// Overload
- value(
- std::nullptr_t,
- storage_ptr sp = {}) noexcept
- : sca_(std::move(sp))
- {
- }
- /** Overload
- @param b The boolean to construct with.
- @param sp
- */
- #ifdef BOOST_JSON_DOCS
- value(
- bool b,
- storage_ptr sp = {}) noexcept;
- #else
- template<class T
- ,class = typename std::enable_if<
- std::is_same<T, bool>::value>::type
- >
- value(
- T b,
- storage_ptr sp = {}) noexcept
- : sca_(b, std::move(sp))
- {
- }
- #endif
- /** Overload
- @param i The number to construct with.
- @param sp
- */
- value(
- signed char i,
- storage_ptr sp = {}) noexcept
- : sca_(static_cast<std::int64_t>(
- i), std::move(sp))
- {
- }
- /// Overload
- value(
- short i,
- storage_ptr sp = {}) noexcept
- : sca_(static_cast<std::int64_t>(
- i), std::move(sp))
- {
- }
- /// Overload
- value(
- int i,
- storage_ptr sp = {}) noexcept
- : sca_(static_cast<std::int64_t>(i),
- std::move(sp))
- {
- }
- /// Overload
- value(
- long i,
- storage_ptr sp = {}) noexcept
- : sca_(static_cast<std::int64_t>(i),
- std::move(sp))
- {
- }
- /// Overload
- value(
- long long i,
- storage_ptr sp = {}) noexcept
- : sca_(static_cast<std::int64_t>(i),
- std::move(sp))
- {
- }
- /** Overload
- @param u The number to construct with.
- @param sp
- */
- value(
- unsigned char u,
- storage_ptr sp = {}) noexcept
- : sca_(static_cast<std::uint64_t>(
- u), std::move(sp))
- {
- }
- /// Overload
- value(
- unsigned short u,
- storage_ptr sp = {}) noexcept
- : sca_(static_cast<std::uint64_t>(u),
- std::move(sp))
- {
- }
- /// Overload
- value(
- unsigned int u,
- storage_ptr sp = {}) noexcept
- : sca_(static_cast<std::uint64_t>(u),
- std::move(sp))
- {
- }
- /// Overload
- value(
- unsigned long u,
- storage_ptr sp = {}) noexcept
- : sca_(static_cast<std::uint64_t>(u),
- std::move(sp))
- {
- }
- /// Overload
- value(
- unsigned long long u,
- storage_ptr sp = {}) noexcept
- : sca_(static_cast<std::uint64_t>(u),
- std::move(sp))
- {
- }
- /** Overload
- @param d The number to construct with.
- @param sp
- */
- value(
- double d,
- storage_ptr sp = {}) noexcept
- : sca_(d, std::move(sp))
- {
- }
- /** Overload
- @param s The string to construct with.
- @param sp
- */
- value(
- string_view s,
- storage_ptr sp = {})
- : str_(s, std::move(sp))
- {
- }
- /// Overload
- value(
- char const* s,
- storage_ptr sp = {})
- : str_(s, std::move(sp))
- {
- }
- /// Overload
- value(
- string s) noexcept
- : str_(std::move(s))
- {
- }
- /// Overload
- value(
- string const& s,
- storage_ptr sp)
- : str_(
- s,
- std::move(sp))
- {
- }
- /// Overload
- value(
- string&& s,
- storage_ptr sp)
- : str_(
- std::move(s),
- std::move(sp))
- {
- }
- /// Overload
- value(
- string_kind_t,
- storage_ptr sp = {}) noexcept
- : str_(std::move(sp))
- {
- }
- /** Overload
- @param arr The array to construct with.
- */
- value(array arr) noexcept
- : arr_(std::move(arr))
- {
- }
- /// Overload
- value(
- array const& arr,
- storage_ptr sp)
- : arr_(
- arr,
- std::move(sp))
- {
- }
- /// Overload
- value(
- array&& arr,
- storage_ptr sp)
- : arr_(
- std::move(arr),
- std::move(sp))
- {
- }
- /// Overload
- value(
- array_kind_t,
- storage_ptr sp = {}) noexcept
- : arr_(std::move(sp))
- {
- }
- /** Overload
- @param obj The object to construct with.
- */
- value(object obj) noexcept
- : obj_(std::move(obj))
- {
- }
- /// Overload
- value(
- object const& obj,
- storage_ptr sp)
- : obj_( obj, std::move(sp) )
- {
- }
- /// Overload
- value(
- object&& obj,
- storage_ptr sp)
- : obj_( std::move(obj), std::move(sp) )
- {
- }
- /// Overload
- value(
- object_kind_t,
- storage_ptr sp = {}) noexcept
- : obj_(std::move(sp))
- {
- }
- /** Overload
- @param init The initializer list to construct from.
- @param sp
- */
- BOOST_JSON_DECL
- value(
- std::initializer_list<value_ref> init,
- storage_ptr sp = {});
- /** Overload
- @param other Another `value`.
- */
- value(value const& other)
- : value(other, other.storage())
- {
- }
- /// Overload
- BOOST_JSON_DECL
- value(
- value const& other,
- storage_ptr sp);
- /// Overload
- BOOST_JSON_DECL
- value(value&& other) noexcept;
- /// Overload
- BOOST_JSON_DECL
- value(
- value&& other,
- storage_ptr sp);
- /// Overload
- value(pilfered<value> other) noexcept
- {
- relocate(this, other.get());
- ::new(&other.get().sca_) scalar();
- }
- /// @}
- //------------------------------------------------------
- //
- // Assignment
- //
- //------------------------------------------------------
- /** Assignment.
- Replaces the contents of this value.
- @li **(1)** replaces with an element-wise copy of the contents of
- `other`.
- @li **(2)** replaces with the contents `other` using move semantics
- (see below).
- @li **(3)** replaces with the value formed by constructing from `init`
- and `this->storage()` (see \<\<initializer_lists\>\>).
- @li **(4)** replaces with null.
- @li **(5)** replaces with the boolean value `b`.
- @li **(6)**--**(10)** replaces with the signed integer `i`.
- @li **(11)**--**(15)** replaces with the unsigned integer `u`.
- @li **(16)** replaces with the number `d`.
- @li **(17)**, **(19)** replaces with a copy of the string `s`.
- @li **(18)**, equivalent to `*this = string_view(s)`.
- @li **(20)** replaces with the string `s` using move semantics
- see below.
- @li **(21)** replaces with a copy of the array `arr`.
- @li **(22)** replaces with the array `arr` using move semantics
- (see below).
- @li **(23)** replaces with a copy of the object `obj`.
- @li **(24)** replaces with the object `obj` using move semantics
- (see below).
- Move assignment for `value` never changes the associated memory
- resource. Because of this if the memory resource of the assigned value
- differs from that of `*this`, the operation is equivalent to a copy.
- Otherwise, it replaces the underlying storage in constant time without
- the possibility of exceptions.
- @par Complexity
- @li **(1)** linear in the sizes of `*this` and `other`.
- @li **(2)** constant if `*this->storage() == *other.storage()`,
- otherwise linear in the sizes of `*this` and `other`.
- @li **(3)** linear in the sizes of `*this` and `init`.
- @li **(4)**--**(16)** linear in the size of `*this`.
- @li **(17)**, **(19)** linear in the size of `*this` and `s.size()`.
- @li **(18)** linear in the size of `*this` and `std::strlen(s)`.
- @li **(22)** constant if `*this->storage() == *s.storage()`,
- otherwise linear in the size of `*this` and `s.size()`.
- @li **(21)** linear in the size of `*this` and `arr.size()`.
- @li **(22)** constant if `*this->storage() == *arr.storage()`,
- otherwise linear in the size of `*this` and `arr.size()`.
- @li **(23)** linear in the size of `*this` and `obj.size()`.
- @li **(24)** constant if `*this->storage() == *obj.storage()`,
- otherwise linear in the size of `*this` and `obj.size()`.
- The size of `*this` is either the size of the underlying container
- (if there is one), or can be considered to be 1.
- @par Exception Safety
- @li **(1)**--**(3)**, **(17)**--**(24)** strong guarantee.
- @li **(4)**--**(16)** no-throw guarantee.
- Calls to `memory_resource::allocate` may throw.
- @param other The source value.
- @{
- */
- BOOST_JSON_DECL
- value&
- operator=(value const& other);
- /** Overload
- The contents of the value are replaced with the
- contents of `other` using move semantics:
- @li If `*other.storage() == *sp`, ownership of
- the underlying memory is transferred in constant
- time, with no possibility of exceptions.
- After assignment, the moved-from value becomes
- a null with its current storage pointer.
- @li If `*other.storage() != *sp`, an
- element-wise copy is performed if
- `other.is_structured() == true`, which may throw.
- In this case, the moved-from value is not
- changed.
- */
- BOOST_JSON_DECL
- value&
- operator=(value&& other);
- /** Overload
- @param init The initializer list to assign from.
- */
- BOOST_JSON_DECL
- value&
- operator=(
- std::initializer_list<value_ref> init);
- /// Overload
- value&
- operator=(std::nullptr_t) noexcept
- {
- if(is_scalar())
- {
- sca_.k = json::kind::null;
- }
- else
- {
- ::new(&sca_) scalar(
- destroy());
- }
- return *this;
- }
- /** Overload
- @param b The new value.
- */
- #ifdef BOOST_JSON_DOCS
- value& operator=(bool b) noexcept;
- #else
- template<class T
- ,class = typename std::enable_if<
- std::is_same<T, bool>::value>::type
- >
- value& operator=(T b) noexcept
- {
- if(is_scalar())
- {
- sca_.b = b;
- sca_.k = json::kind::bool_;
- }
- else
- {
- ::new(&sca_) scalar(
- b, destroy());
- }
- return *this;
- }
- #endif
- /** Overload
- @param i The new value.
- */
- value& operator=(signed char i) noexcept
- {
- return operator=(
- static_cast<long long>(i));
- }
- /// Overload
- value& operator=(short i) noexcept
- {
- return operator=(
- static_cast<long long>(i));
- }
- /// Overload
- value& operator=(int i) noexcept
- {
- return operator=(
- static_cast<long long>(i));
- }
- /// Overload
- value& operator=(long i) noexcept
- {
- return operator=(
- static_cast<long long>(i));
- }
- /// Overload
- value& operator=(long long i) noexcept
- {
- if(is_scalar())
- {
- sca_.i = i;
- sca_.k = json::kind::int64;
- }
- else
- {
- ::new(&sca_) scalar(static_cast<
- std::int64_t>(i), destroy());
- }
- return *this;
- }
- /** Overload
- @param u The new value.
- */
- value& operator=(unsigned char u) noexcept
- {
- return operator=(static_cast<
- unsigned long long>(u));
- }
- /// Overload
- value& operator=(unsigned short u) noexcept
- {
- return operator=(static_cast<
- unsigned long long>(u));
- }
- /// Overload
- value& operator=(unsigned int u) noexcept
- {
- return operator=(static_cast<
- unsigned long long>(u));
- }
- /// Overload
- value& operator=(unsigned long u) noexcept
- {
- return operator=(static_cast<
- unsigned long long>(u));
- }
- /// Overload
- value& operator=(unsigned long long u) noexcept
- {
- if(is_scalar())
- {
- sca_.u = u;
- sca_.k = json::kind::uint64;
- }
- else
- {
- ::new(&sca_) scalar(static_cast<
- std::uint64_t>(u), destroy());
- }
- return *this;
- }
- /** Overload
- @param d The new value.
- */
- value& operator=(double d) noexcept
- {
- if(is_scalar())
- {
- sca_.d = d;
- sca_.k = json::kind::double_;
- }
- else
- {
- ::new(&sca_) scalar(
- d, destroy());
- }
- return *this;
- }
- /** Overload
- @param s The new string.
- */
- BOOST_JSON_DECL
- value& operator=(string_view s);
- /// Overload
- BOOST_JSON_DECL
- value& operator=(char const* s);
- /// Overload
- BOOST_JSON_DECL
- value& operator=(string const& s);
- /** Overload
- The contents of the value are replaced with the
- contents of `s` using move semantics:
- @li If `*other.storage() == *this->storage()`,
- ownership of the underlying memory is transferred
- in constant time, with no possibility of exceptions.
- After assignment, the moved-from string becomes
- empty with its current storage pointer.
- @li If `*other.storage() != *this->storage()`, an
- element-wise copy is performed, which may throw.
- In this case, the moved-from string is not
- changed.
- @param s The string to move-assign from.
- */
- BOOST_JSON_DECL
- value& operator=(string&& s);
- /** Overload
- Replace `*this` with a copy of the array `arr`.
- @par Exception Safety
- Strong guarantee.
- Calls to `memory_resource::allocate` may throw.
- @par Complexity
- Linear in the sum of sizes of `*this` and `arr`
- @param arr The new array.
- */
- BOOST_JSON_DECL
- value& operator=(array const& arr);
- /** Overload
- The contents of the value are replaced with the
- contents of `arr` using move semantics:
- @li If `*arr.storage() == *this->storage()`,
- ownership of the underlying memory is transferred
- in constant time, with no possibility of exceptions.
- After assignment, the moved-from array becomes
- empty with its current storage pointer.
- @li If `*arr.storage() != *this->storage()`, an
- element-wise copy is performed, which may throw.
- In this case, the moved-from array is not
- changed.
- @par Complexity
- Constant, or linear in the size of `*this` plus `arr.size()`.
- @par Exception Safety
- Strong guarantee.
- Calls to `memory_resource::allocate` may throw.
- @param arr The array to move-assign from.
- */
- BOOST_JSON_DECL
- value& operator=(array&& arr);
- /** Overload
- Replace `*this` with a copy of the obect `obj`.
- @par Exception Safety
- Strong guarantee.
- Calls to `memory_resource::allocate` may throw.
- @par Complexity
- Linear in the sum of sizes of `*this` and `obj`
- @param obj The new object.
- */
- BOOST_JSON_DECL
- value& operator=(object const& obj);
- /** Overload
- The contents of the value are replaced with the
- contents of `obj` using move semantics:
- @li If `*obj.storage() == *this->storage()`,
- ownership of the underlying memory is transferred
- in constant time, with no possibility of exceptions.
- After assignment, the moved-from object becomes
- empty with its current storage pointer.
- @li If `*obj.storage() != *this->storage()`, an
- element-wise copy is performed, which may throw.
- In this case, the moved-from object is not
- changed.
- @par Complexity
- Constant, or linear in the size of `*this` plus `obj.size()`.
- @par Exception Safety
- Strong guarantee.
- Calls to `memory_resource::allocate` may throw.
- @param obj The object to move-assign from.
- */
- BOOST_JSON_DECL
- value& operator=(object&& obj);
- /// @}
- //------------------------------------------------------
- //
- // Modifiers
- //
- //------------------------------------------------------
- /** Replace with a null value.
- The current value is destroyed and the kind is changed to kind::null.
- The associated memeory resource is kept unchanged.
- @par Complexity
- Linear in the size of `*this`.
- @par Exception Safety
- No-throw guarantee.
- */
- void
- emplace_null() noexcept
- {
- *this = nullptr;
- }
- /** Replace with a `bool` value.
- The value is replaced with a `bool` initialized to `false`, destroying
- the previous contents, but keeping the memeory resource.
- @par Complexity
- Linear in the size of `*this`.
- @par Exception Safety
- No-throw guarantee.
- @return `this->get_bool()`.
- */
- bool&
- emplace_bool() noexcept
- {
- *this = false;
- return sca_.b;
- }
- /** Replace with a `std::int64_t` value.
- The value is replaced with a `std::int64_t` initialized to zero,
- destroying the previous contents, but keeping the memeory resource.
- @par Complexity
- Linear in the size of `*this`.
- @par Exception Safety
- No-throw guarantee.
- @return `this->get_int64()`.
- */
- std::int64_t&
- emplace_int64() noexcept
- {
- *this = std::int64_t{};
- return sca_.i;
- }
- /** Replace with a `std::uint64_t` value.
- The value is replaced with a `std::uint64_t` initialized to zero,
- destroying the the previous contents, but keeping the memeory resource.
- @par Complexity
- Linear in the size of `*this`.
- @par Exception Safety
- No-throw guarantee.
- @return `this->get_uint64()`.
- */
- std::uint64_t&
- emplace_uint64() noexcept
- {
- *this = std::uint64_t{};
- return sca_.u;
- }
- /** Replace with a `double` value.
- The value is replaced with a `double` initialized to zero, destroying
- the previous contents, but keeping the memeory resource.
- @par Complexity
- Linear in the size of `*this`.
- @par Exception Safety
- No-throw guarantee.
- @return `this->get_double()`.
- */
- double&
- emplace_double() noexcept
- {
- *this = double{};
- return sca_.d;
- }
- /** Replace with an empty @ref string.
- The value is replaced with an empty @ref string using the current
- memory resource, destroying the previous contents. All previously
- obtained iterators and references obtained beforehand are invalidated.
- @par Complexity
- Linear in the size of `*this`.
- @par Exception Safety
- No-throw guarantee.
- @return `this->get_string()`.
- */
- BOOST_JSON_DECL
- string&
- emplace_string() noexcept;
- /** Replace with an empty array.
- The value is replaced with an empty @ref array using the current memory
- resource, destroying the previous contents. All previously obtained
- iterators and references obtained beforehand are invalidated.
- @par Complexity
- Linear in the size of `*this`.
- @par Exception Safety
- No-throw guarantee.
- @return `this->get_array()`.
- */
- BOOST_JSON_DECL
- array&
- emplace_array() noexcept;
- /** Replace with an empty @ref object.
- The value is replaced with an empty @ref array using the current memory
- resource, destroying the previous contents. All previously obtained
- iterators and references obtained beforehand are invalidated.
- @par Complexity
- Linear in the size of `*this`.
- @par Exception Safety
- No-throw guarantee.
- @return `this->get_object()`.
- */
- BOOST_JSON_DECL
- object&
- emplace_object() noexcept;
- /** Swap the given values.
- Exchanges the contents of this value with another value. Ownership of
- the respective @ref boost::container::pmr::memory_resource objects is
- not transferred:
- @li If `this == &other`, this function has no effect.
- @li If `*other.storage() == *this->storage()`, ownership of the
- underlying memory is swapped in constant time, with no possibility
- of exceptions. All iterators and references remain valid.
- @li If `*other.storage() != *this->storage()`, the contents are
- logically swapped by making copies, which can throw. In this case
- all iterators and references are invalidated.
- @par Complexity
- Constant or linear in the sum of the sizes of the values.
- @par Exception Safety
- Strong guarantee. Calls to `memory_resource::allocate` may throw.
- @param other The value to swap with.
- */
- BOOST_JSON_DECL
- void
- swap(value& other);
- /** Swap the given values.
- Exchanges the contents of value `lhs` with another value `rhs`.
- Ownership of the respective @ref boost::container::pmr::memory_resource
- objects is not transferred.
- @li If `&lhs == &rhs`, this function call has no effect.
- @li If `*lhs.storage() == *rhs.storage()`, ownership of the underlying
- memory is swapped in constant time, with no possibility of
- exceptions. All iterators and references remain valid.
- @li If `*lhs.storage() != *rhs.storage`, the contents are logically
- swapped by a copy, which can throw. In this case all iterators and
- references are invalidated.
- @par Complexity
- Constant or linear in the sum of the sizes of the values.
- @par Exception Safety
- Strong guarantee. Calls to `memory_resource::allocate` may throw.
- @param lhs The value to exchange.
- @param rhs The value to exchange.
- @see @ref value::swap
- */
- friend
- void
- swap(value& lhs, value& rhs)
- {
- lhs.swap(rhs);
- }
- //------------------------------------------------------
- //
- // Observers
- //
- //------------------------------------------------------
- /** Returns the kind of this JSON value.
- This function returns the discriminating enumeration constant of type
- @ref json::kind corresponding to the underlying representation stored
- in the container.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- json::kind
- kind() const noexcept
- {
- return static_cast<json::kind>(
- static_cast<unsigned char>(
- sca_.k) & 0x3f);
- }
- /** Check if this is an @ref array.
- Returns `true` if the value's @ref kind() is `kind::array`.
- @returns `this->kind() == kind::array`.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- bool
- is_array() const noexcept
- {
- return kind() == json::kind::array;
- }
- /** Check if this is an @ref object.
- Returns `true` if the value's @ref kind() is `kind::object`.
- @returns `this->kind() == kind::object`.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- bool
- is_object() const noexcept
- {
- return kind() == json::kind::object;
- }
- /** Check if this is a @ref string.
- Returns `true` if the value's @ref kind() is `kind::string`.
- @returns `this->kind() == kind::string`.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- bool
- is_string() const noexcept
- {
- return kind() == json::kind::string;
- }
- /** Check if this is a `std::int64_t`.
- Returns `true` if the value's @ref kind() is `kind::int64`.
- @returns `this->kind() == kind::int64`.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- bool
- is_int64() const noexcept
- {
- return kind() == json::kind::int64;
- }
- /** Checks if this is a `std::uint64_t`.
- Returns `true` if the value's @ref kind() is `kind::uint64`.
- @returns `this->kind() == kind::uint64`.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- bool
- is_uint64() const noexcept
- {
- return kind() == json::kind::uint64;
- }
- /** Check if this is a `double`.
- Returns `true` if the value's @ref kind() is `kind::double_`.
- @returns `this->kind() == kind::double_`.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- bool
- is_double() const noexcept
- {
- return kind() == json::kind::double_;
- }
- /** Check if this is a `bool`.
- Returns `true` if the value's @ref kind() is `kind::bool_`.
- @returns `this->kind() == kind::bool_`.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- bool
- is_bool() const noexcept
- {
- return kind() == json::kind::bool_;
- }
- /** Check if this is a null value.
- Returns `true` if the value's @ref kind() is `kind::null`.
- @returns `this->kind() == kind::null`.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- bool
- is_null() const noexcept
- {
- return kind() == json::kind::null;
- }
- /** Checks if this is an @ref array or an @ref object.
- This function returns `true` if @ref kind() is either `kind::object` or
- `kind::array`.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- bool
- is_structured() const noexcept
- {
- // VFALCO Could use bit 0x20 for this
- return
- kind() == json::kind::object ||
- kind() == json::kind::array;
- }
- /** Check if this is not an @ref array or @ref object.
- This function returns `true` if @ref kind() is neither `kind::object`
- nor `kind::array`.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- bool
- is_primitive() const noexcept
- {
- // VFALCO Could use bit 0x20 for this
- return
- sca_.k != json::kind::object &&
- sca_.k != json::kind::array;
- }
- /** Check if this is a number.
- This function returns `true` when @ref kind() is one of `kind::int64`,
- `kind::uint64`, or `kind::double_`.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- bool
- is_number() const noexcept
- {
- // VFALCO Could use bit 0x40 for this
- return
- kind() == json::kind::int64 ||
- kind() == json::kind::uint64 ||
- kind() == json::kind::double_;
- }
- //------------------------------------------------------
- /** Return a pointer to the underlying @ref array.
- If `this->kind() == kind::array`, returns a pointer to the underlying
- array. Otherwise, returns `nullptr`.
- @par Example
- The return value is used in both a boolean context and
- to assign a variable:
- @code
- if( auto p = jv.if_array() )
- return *p;
- @endcode
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- array const*
- if_array() const noexcept
- {
- if(kind() == json::kind::array)
- return &arr_;
- return nullptr;
- }
- array*
- if_array() noexcept
- {
- if(kind() == json::kind::array)
- return &arr_;
- return nullptr;
- }
- /// @}
- /** Return a pointer to the underlying @ref object.
- If `this->kind() == kind::object`, returns a pointer to the underlying
- object. Otherwise, returns `nullptr`.
- @par Example
- The return value is used in both a boolean context and
- to assign a variable:
- @code
- if( auto p = jv.if_object() )
- return *p;
- @endcode
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- object const*
- if_object() const noexcept
- {
- if(kind() == json::kind::object)
- return &obj_;
- return nullptr;
- }
- object*
- if_object() noexcept
- {
- if(kind() == json::kind::object)
- return &obj_;
- return nullptr;
- }
- /// @}
- /** Return a pointer to the underlying @ref string.
- If `this->kind() == kind::string`, returns a pointer to the underlying
- object. Otherwise, returns `nullptr`.
- @par Example
- The return value is used in both a boolean context and
- to assign a variable:
- @code
- if( auto p = jv.if_string() )
- return *p;
- @endcode
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- string const*
- if_string() const noexcept
- {
- if(kind() == json::kind::string)
- return &str_;
- return nullptr;
- }
- string*
- if_string() noexcept
- {
- if(kind() == json::kind::string)
- return &str_;
- return nullptr;
- }
- /// @}
- /** Return a pointer to the underlying `std::int64_t`.
- If `this->kind() == kind::int64`, returns a pointer to the underlying
- integer. Otherwise, returns `nullptr`.
- @par Example
- The return value is used in both a boolean context and
- to assign a variable:
- @code
- if( auto p = jv.if_int64() )
- return *p;
- @endcode
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- std::int64_t const*
- if_int64() const noexcept
- {
- if(kind() == json::kind::int64)
- return &sca_.i;
- return nullptr;
- }
- std::int64_t*
- if_int64() noexcept
- {
- if(kind() == json::kind::int64)
- return &sca_.i;
- return nullptr;
- }
- /// @}
- /** Return a pointer to the underlying `std::uint64_t`.
- If `this->kind() == kind::uint64`, returns a pointer to the underlying
- unsigned integer. Otherwise, returns `nullptr`.
- @par Example
- The return value is used in both a boolean context and
- to assign a variable:
- @code
- if( auto p = jv.if_uint64() )
- return *p;
- @endcode
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- std::uint64_t const*
- if_uint64() const noexcept
- {
- if(kind() == json::kind::uint64)
- return &sca_.u;
- return nullptr;
- }
- std::uint64_t*
- if_uint64() noexcept
- {
- if(kind() == json::kind::uint64)
- return &sca_.u;
- return nullptr;
- }
- /// @}
- /** Return a pointer to the underlying `double`.
- If `this->kind() == kind::double_`, returns a pointer to the underlying
- double. Otherwise, returns `nullptr`.
- @par Example
- The return value is used in both a boolean context and
- to assign a variable:
- @code
- if( auto p = jv.if_double() )
- return *p;
- @endcode
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- double const*
- if_double() const noexcept
- {
- if(kind() == json::kind::double_)
- return &sca_.d;
- return nullptr;
- }
- double*
- if_double() noexcept
- {
- if(kind() == json::kind::double_)
- return &sca_.d;
- return nullptr;
- }
- /// @}
- /** Return a pointer to the underlying `bool` .
- If `this->kind() == kind::bool_`, returns a pointer to the underlying
- boolean. Otherwise, returns `nullptr`.
- @par Example
- The return value is used in both a boolean context and
- to assign a variable:
- @code
- if( auto p = jv.if_bool() )
- return *p;
- @endcode
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- bool const*
- if_bool() const noexcept
- {
- if(kind() == json::kind::bool_)
- return &sca_.b;
- return nullptr;
- }
- bool*
- if_bool() noexcept
- {
- if(kind() == json::kind::bool_)
- return &sca_.b;
- return nullptr;
- }
- /// @}
- //------------------------------------------------------
- /** Return the stored number cast to an arithmetic type.
- This function attempts to return the stored value converted to the
- arithmetic type `T` which may not be `bool`:
- @li If `T` is an integral type and the stored value is a number which
- can be losslessly converted, the conversion is performed without
- error and the converted number is returned.
- @li If `T` is an integral type and the stored value is a number which
- cannot be losslessly converted, then the operation fails with
- an error.
- @li If `T` is a floating point type and the stored value is a number,
- the conversion is performed without error. The converted number is
- returned, with a possible loss of precision.
- @li Otherwise, if the stored value is not a number; that is, if
- @ref is_number() returns `false`, then the operation fails with
- an error.
- @par Constraints
- @code
- std::is_arithmetic< T >::value && ! std::is_same< T, bool >::value
- @endcode
- @par Complexity
- Constant.
- @par Exception Safety
- @li **(1)**, **(2)** no-throw guarantee.
- @li **(3)** strong guarantee.
- @return The converted number.
- @param ec Set to the error, if any occurred.
- @return The converted number.
- @{
- */
- template<class T>
- #ifdef BOOST_JSON_DOCS
- T
- #else
- typename std::enable_if<
- std::is_arithmetic<T>::value &&
- ! std::is_same<T, bool>::value,
- T>::type
- #endif
- to_number(system::error_code& ec) const noexcept
- {
- error e;
- auto result = to_number<T>(e);
- BOOST_JSON_FAIL(ec, e);
- return result;
- }
- template<class T>
- #ifdef BOOST_JSON_DOCS
- T
- #else
- typename std::enable_if<
- std::is_arithmetic<T>::value &&
- ! std::is_same<T, bool>::value,
- T>::type
- #endif
- to_number(std::error_code& ec) const noexcept
- {
- system::error_code jec;
- auto result = to_number<T>(jec);
- ec = jec;
- return result;
- }
- /** Overload
- @throws boost::system::system_error Overload **(3)** reports errors by
- throwing an exception.
- */
- template<class T>
- #ifdef BOOST_JSON_DOCS
- T
- #else
- typename std::enable_if<
- std::is_arithmetic<T>::value &&
- ! std::is_same<T, bool>::value,
- T>::type
- #endif
- to_number() const
- {
- return try_to_number<T>().value();
- }
- /// @}
- /** Return the stored number as @ref boost::system::result.
- This function attempts to return the stored value converted to the
- arithmetic type `T` which may not be `bool`:
- @li If `T` is an integral type and the stored value is a number which
- can be losslessly converted, the conversion is performed without
- error and `result<T>` containing the converted number is returned.
- @li If `T` is an integral type and the stored value is a number which
- cannot be losslessly converted, then `result<T>` containing the
- corresponding `error_code` is returned.
- @li If `T` is a floating point type and the stored value is a number,
- the conversion is performed without error. `result<T>` containing
- the converted number, with a possible loss of precision, is
- returned.
- @li Otherwise, if the stored value is not a number; that is, if
- `this->is_number()` returns `false`, then `result<T>` containing
- the corresponding `error_code` is returned.
- @par Constraints
- @code
- std::is_arithmetic< T >::value && ! std::is_same< T, bool >::value
- @endcode
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @return `boost::system::result<T>` with either the converted number or
- an `error_code`.
- */
- template<class T>
- #ifdef BOOST_JSON_DOCS
- system::result<T>
- #else
- typename std::enable_if<
- std::is_arithmetic<T>::value && ! std::is_same<T, bool>::value,
- system::result<T>
- >::type
- #endif
- try_to_number() const noexcept
- {
- system::error_code ec;
- T result = to_number<T>(ec);
- if( ec )
- return {system::in_place_error, ec};
- return {system::in_place_value, result};
- }
- //------------------------------------------------------
- //
- // Accessors
- //
- //------------------------------------------------------
- /** 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();
- }
- //------------------------------------------------------
- /** Return `result` with a reference to the underlying @ref array
- If @ref is_array() is `true`, the result contains a reference to the
- underlying @ref array, otherwise it contains an `error_code`.
- @par Example
- The return value can be used in both a boolean context and
- to assign a variable:
- @code
- if( auto r = jv.try_as_array() )
- return *r;
- @endcode
- But can also be used to throw an exception on error:
- @code
- return jv.try_as_array().value();
- @endcode
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- BOOST_JSON_DECL
- system::result<array&>
- try_as_array() noexcept;
- BOOST_JSON_DECL
- system::result<array const&>
- try_as_array() const noexcept;
- /// @}
- /** Return `result` with a reference to the underlying @ref object.
- If @ref is_object() is `true`, the result contains a reference to the
- underlying @ref object, otherwise it contains an `error_code`.
- @par Example
- The return value can be used in both a boolean context and
- to assign a variable:
- @code
- if( auto r = jv.try_as_object() )
- return *r;
- @endcode
- But can also be used to throw an exception on error:
- @code
- return jv.try_as_object().value();
- @endcode
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- BOOST_JSON_DECL
- system::result<object&>
- try_as_object() noexcept;
- BOOST_JSON_DECL
- system::result<object const&>
- try_as_object() const noexcept;
- /// @}
- /** Return `result` with a reference to the underlying @ref string.
- If @ref is_string() is `true`, the result contains a reference to the
- underlying @ref string, otherwise it contains an `error_code`.
- @par Example
- The return value can be used in both a boolean context and
- to assign a variable:
- @code
- if( auto r = jv.try_as_string() )
- return *r;
- @endcode
- But can also be used to throw an exception on error:
- @code
- return jv.try_as_string().value();
- @endcode
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- BOOST_JSON_DECL
- system::result<string&>
- try_as_string() noexcept;
- BOOST_JSON_DECL
- system::result<string const&>
- try_as_string() const noexcept;
- /// @}
- /** Return `result` with the underlying `std::int64_t`
- If @ref is_int64() is `true`, the result contains a reference to **(1)**
- or a copy of **(2)** the underlying `std::int64_t`, otherwise it
- contains an `error_code`.
- @par Example
- The return value can be used in both a boolean context and
- to assign a variable:
- @code
- if( auto r = jv.try_as_int64() )
- return *r;
- @endcode
- But can also be used to throw an exception on error:
- @code
- return jv.try_as_int64().value();
- @endcode
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- BOOST_JSON_DECL
- system::result<std::int64_t&>
- try_as_int64() noexcept;
- BOOST_JSON_DECL
- system::result<std::int64_t>
- try_as_int64() const noexcept;
- /// @}
- /** Return `result` with the underlying `std::uint64_t`.
- If @ref is_uint64() is `true`, the result contains a reference to **(1)**
- or a copy of **(2)** the underlying `std::uint64_t`, otherwise it
- contains an `error_code`.
- @par Example
- The return value can be used in both a boolean context and
- to assign a variable:
- @code
- if( auto r = jv.try_as_uint64() )
- return *r;
- @endcode
- But can also be used to throw an exception on error:
- @code
- return jv.try_as_uint64().value();
- @endcode
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- BOOST_JSON_DECL
- system::result<std::uint64_t&>
- try_as_uint64() noexcept;
- BOOST_JSON_DECL
- system::result<std::uint64_t>
- try_as_uint64() const noexcept;
- /// @}
- /** Return `result` with the underlying `double`
- If @ref is_double() is `true`, the result contains a reference to **(1)**
- or a copy of **(2)** the underlying `double`, otherwise it
- contains an `error_code`.
- @par Example
- The return value can be used in both a boolean context and
- to assign a variable:
- @code
- if( auto r = jv.try_as_double() )
- return *r;
- @endcode
- But can also be used to throw an exception on error:
- @code
- return jv.try_as_double().value();
- @endcode
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- BOOST_JSON_DECL
- system::result<double&>
- try_as_double() noexcept;
- BOOST_JSON_DECL
- system::result<double>
- try_as_double() const noexcept;
- /// @}
- /** Return `result` with the underlying `bool`
- If @ref is_bool() is `true`, the result contains a reference to **(1)**
- or a copy to **(2)** the underlying `bool`, otherwise it contains an
- `error_code`.
- @par Example
- The return value can be used in both a boolean context and
- to assign a variable:
- @code
- if( auto r = jv.try_as_bool() )
- return *r;
- @endcode
- But can also be used to throw an exception on error:
- @code
- return jv.try_as_bool().value();
- @endcode
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- BOOST_JSON_DECL
- system::result<bool&>
- try_as_bool() noexcept;
- BOOST_JSON_DECL
- system::result<bool>
- try_as_bool() const noexcept;
- /// @}
- /** Return engaged `result` if the `value` is null.
- If @ref is_null() is `true`, the result is engaged, otherwise it
- contains an `error_code`.
- @par Example
- The return value can be used in both a boolean context and
- to assign a variable:
- @code
- if( auto r = jv.try_as_null() )
- return *r;
- @endcode
- But can also be used to throw an exception on error:
- @code
- return jv.try_as_null().value();
- @endcode
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- BOOST_JSON_DECL
- system::result<std::nullptr_t>
- try_as_null() const noexcept;
- //------------------------------------------------------
- /** Return the underlying @ref object, or throw an exception.
- If @ref is_object() is `true`, returns a reference to the underlying
- @ref object, otherwise throws an exception.
- @par Exception Safety
- Strong guarantee.
- @throw boost::system::system_error `! this->is_object()`.
- @param loc @ref boost::source_location to use in thrown exception; the
- source location of the call site by default.
- @par Complexity
- Constant.
- @{
- */
- object&
- as_object(source_location const& loc = BOOST_CURRENT_LOCATION) &
- {
- auto& self = const_cast<value const&>(*this);
- return const_cast<object&>( self.as_object(loc) );
- }
- /// Overload
- object&&
- as_object(source_location const& loc = BOOST_CURRENT_LOCATION) &&
- {
- return std::move( as_object(loc) );
- }
- /// Overload
- BOOST_JSON_DECL
- object const&
- as_object(source_location const& loc = BOOST_CURRENT_LOCATION) const&;
- /// @}
- /** Return the underlying @ref array, or throw an exception.
- If @ref is_array() is `true`, returns a reference to the underlying
- @ref array, otherwise throws an exception.
- @par Exception Safety
- Strong guarantee.
- @throw boost::system::system_error `! this->is_array()`.
- @param loc @ref boost::source_location to use in thrown exception; the
- source location of the call site by default.
- @par Complexity
- Constant.
- @{
- */
- array&
- as_array(source_location const& loc = BOOST_CURRENT_LOCATION) &
- {
- auto& self = const_cast<value const&>(*this);
- return const_cast<array&>( self.as_array(loc) );
- }
- /// Overload
- array&&
- as_array(source_location const& loc = BOOST_CURRENT_LOCATION) &&
- {
- return std::move( as_array(loc) );
- }
- /// Overload
- BOOST_JSON_DECL
- array const&
- as_array(source_location const& loc = BOOST_CURRENT_LOCATION) const&;
- /// @}
- /** Return the underlying @ref string, or throw an exception.
- If @ref is_string() is `true`, returns a reference to the underlying
- @ref string, otherwise throws an exception.
- @par Exception Safety
- Strong guarantee.
- @throw boost::system::system_error `! this->is_string()`.
- @param loc @ref boost::source_location to use in thrown exception; the
- source location of the call site by default.
- @par Complexity
- Constant.
- @{
- */
- string&
- as_string(source_location const& loc = BOOST_CURRENT_LOCATION) &
- {
- auto& self = const_cast<value const&>(*this);
- return const_cast<string&>( self.as_string(loc) );
- }
- /// Overload
- string&&
- as_string(source_location const& loc = BOOST_CURRENT_LOCATION) &&
- {
- return std::move( as_string(loc) );
- }
- /// Overload
- BOOST_JSON_DECL
- string const&
- as_string(source_location const& loc = BOOST_CURRENT_LOCATION) const&;
- /// @}
- /** Return the underlying `std::int64_t`, or throw an exception.
- If @ref is_int64() is `true`, returns a reference to **(1)** or a copy
- of **(2)** the underlying `std::int64_t`, otherwise throws an
- exception.
- @note This function is the intended for direct access to the underlying
- object, __if__ it has the type `std::int64_t`. It does not convert the
- underlying object to the type `std::int64_t` even if a lossless
- conversion is possible. If you are not sure which kind your `value`
- has, and you only care about getting a `std::int64_t` number, consider
- using @ref to_number instead.
- @par Exception Safety
- Strong guarantee.
- @throw boost::system::system_error `! this->is_int64()`.
- @param loc @ref boost::source_location to use in thrown exception; the
- source location of the call site by default.
- @par Complexity
- Constant.
- @{
- */
- BOOST_JSON_DECL
- std::int64_t&
- as_int64(source_location const& loc = BOOST_CURRENT_LOCATION);
- /// Overload
- BOOST_JSON_DECL
- std::int64_t
- as_int64(source_location const& loc = BOOST_CURRENT_LOCATION) const;
- /// @}
- /** Return the underlying `std::uint64_t`, or throw an exception.
- If @ref is_uint64() is `true`, returns a reference to **(1)** or a
- copy of **(2)** the underlying `std::uint64_t`, otherwise throws an
- exception.
- @note This function is intended for direct access to the underlying
- object, __if__ it has the type `std::uint64_t`. It does not convert the
- underlying object to the type `std::uint64_t` even if a lossless
- conversion is possible. If you are not sure which kind your `value`
- has, and you only care about getting a `std::uint64_t` number, consider
- using @ref to_number instead.
- @par Exception Safety
- Strong guarantee.
- @throw boost::system::system_error `! this->is_uint64()`.
- @param loc @ref boost::source_location to use in thrown exception; the
- source location of the call site by default.
- @par Complexity
- Constant.
- @{
- */
- BOOST_JSON_DECL
- std::uint64_t&
- as_uint64(source_location const& loc = BOOST_CURRENT_LOCATION);
- /// Overload
- BOOST_JSON_DECL
- std::uint64_t
- as_uint64(source_location const& loc = BOOST_CURRENT_LOCATION) const;
- /// @}
- /** Return the underlying `double`, or throw an exception.
- If @ref is_double() is `true`, returns a reference to **(1)** or a copy
- of **(2)** the underlying `double`, otherwise throws an exception.
- @note This function is intended for direct access to the underlying
- object, __if__ it has the type `double`. It does not convert the
- underlying object to type `double` even if a lossless conversion is
- possible. If you are not sure which kind your `value` has, and you only
- care about getting a `double` number, consider using @ref to_number
- instead.
- @par Exception Safety
- Strong guarantee.
- @throw boost::system::system_error `! this->is_double()`.
- @param loc @ref boost::source_location to use in thrown exception; the
- source location of the call site by default.
- @par Complexity
- Constant.
- @{
- */
- BOOST_JSON_DECL
- double&
- as_double(source_location const& loc = BOOST_CURRENT_LOCATION);
- /// Overload
- BOOST_JSON_DECL
- double
- as_double(source_location const& loc = BOOST_CURRENT_LOCATION) const;
- /// @}
- /** Return the underlying `bool`, or throw an exception.
- If @ref is_bool() is `true`, returns a reference to **(1)** or a copy
- of **(2)** the underlying `bool`, otherwise throws an exception.
- @par Exception Safety
- Strong guarantee.
- @throw boost::system::system_error `! this->is_bool()`.
- @param loc @ref boost::source_location to use in thrown exception; the
- source location of the call site by default.
- @par Complexity
- Constant.
- @{
- */
- BOOST_JSON_DECL
- bool&
- as_bool(source_location const& loc = BOOST_CURRENT_LOCATION);
- /// Overload
- BOOST_JSON_DECL
- bool
- as_bool(source_location const& loc = BOOST_CURRENT_LOCATION) const;
- /// @}
- //------------------------------------------------------
- /** Return the underlying @ref object, without checking.
- This is the fastest way to access the underlying representation when
- the kind is known in advance.
- @par Preconditions
- @code
- this->is_object()
- @endcode
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- object&
- get_object() & noexcept
- {
- BOOST_ASSERT(is_object());
- return obj_;
- }
- object&&
- get_object() && noexcept
- {
- BOOST_ASSERT(is_object());
- return std::move(obj_);
- }
- object const&
- get_object() const& noexcept
- {
- BOOST_ASSERT(is_object());
- return obj_;
- }
- /// @}
- /** Return the underlying @ref array, without checking.
- This is the fastest way to access the underlying representation when
- the kind is known in advance.
- @par Preconditions
- @code
- this->is_array()
- @endcode
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- array&
- get_array() & noexcept
- {
- BOOST_ASSERT(is_array());
- return arr_;
- }
- array&&
- get_array() && noexcept
- {
- BOOST_ASSERT(is_array());
- return std::move(arr_);
- }
- array const&
- get_array() const& noexcept
- {
- BOOST_ASSERT(is_array());
- return arr_;
- }
- /// @}
- /** Return the underlying @ref string, without checking.
- This is the fastest way to access the underlying representation when
- the kind is known in advance.
- @par Preconditions
- @code
- this->is_string()
- @endcode
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- string&
- get_string() & noexcept
- {
- BOOST_ASSERT(is_string());
- return str_;
- }
- string&&
- get_string() && noexcept
- {
- BOOST_ASSERT(is_string());
- return std::move(str_);
- }
- string const&
- get_string() const& noexcept
- {
- BOOST_ASSERT(is_string());
- return str_;
- }
- /// @}
- /** Return the underlying `std::int64_t`, without checking.
- This is the fastest way to access the underlying representation when
- the kind is known in advance.
- @par Preconditions
- @code
- this->is_int64()
- @endcode
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- std::int64_t&
- get_int64() noexcept
- {
- BOOST_ASSERT(is_int64());
- return sca_.i;
- }
- std::int64_t
- get_int64() const noexcept
- {
- BOOST_ASSERT(is_int64());
- return sca_.i;
- }
- /// @}
- /** Return the underlying `std::uint64_t`, without checking.
- This is the fastest way to access the underlying representation when
- the kind is known in advance.
- @par Preconditions
- @code
- this->is_uint64()
- @endcode
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- std::uint64_t&
- get_uint64() noexcept
- {
- BOOST_ASSERT(is_uint64());
- return sca_.u;
- }
- std::uint64_t
- get_uint64() const noexcept
- {
- BOOST_ASSERT(is_uint64());
- return sca_.u;
- }
- /// @}
- /** Return the underlying `double`, without checking.
- This is the fastest way to access the underlying
- representation when the kind is known in advance.
- @par Preconditions
- @code
- this->is_double()
- @endcode
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- double&
- get_double() noexcept
- {
- BOOST_ASSERT(is_double());
- return sca_.d;
- }
- double
- get_double() const noexcept
- {
- BOOST_ASSERT(is_double());
- return sca_.d;
- }
- /// @}
- /** Return the underlying `bool`, without checking.
- This is the fastest way to access the underlying representation when
- the kind is known in advance.
- @par Preconditions
- @code
- this->is_bool()
- @endcode
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- bool&
- get_bool() noexcept
- {
- BOOST_ASSERT(is_bool());
- return sca_.b;
- }
- bool
- get_bool() const noexcept
- {
- BOOST_ASSERT(is_bool());
- return sca_.b;
- }
- /// @}
- //------------------------------------------------------
- /** Access an element, with bounds checking.
- Returns `boost::system::result` containing a reference to the element
- of the underlying ccontainer, if such element exists. If the underlying
- value is not a container of the suitable type or the container doesn't
- have a corresponding element the result contains an `error_code`.
- , if `pos` is within its range. If `pos` is
- outside of that range, or the underlying value is not an object the
- Returns @ref boost::system::result containing a reference to the
- element of the underlying @ref array, if `pos` is within its range. If
- `pos` is outside of that range, or the underlying value is not an array
- the result contains an `error_code`.
- This function is used to access elements of
- the underlying container, or throw an exception if that could not be
- done.
- @li **(1)**, **(2)** require the underlying container to be an
- @ref object, and look for an element with the key `key`.
- @li **(3)**, **(4)** require the underlying container to be an
- @ref array, and look for an element at index `pos`.
- @par Exception Safety
- No-throw guarantee.
- @param key The key of the element to find.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- BOOST_JSON_DECL
- boost::system::result<value&>
- try_at(string_view key) noexcept;
- BOOST_JSON_DECL
- boost::system::result<value const&>
- try_at(string_view key) const noexcept;
- /** Overload
- @param pos A zero-based array index.
- */
- BOOST_JSON_DECL
- boost::system::result<value&>
- try_at(std::size_t pos) noexcept;
- /// Overload
- BOOST_JSON_DECL
- boost::system::result<value const&>
- try_at(std::size_t pos) const noexcept;
- /// @}
- /** Access an element, with bounds checking.
- This function is used to access elements of
- the underlying container, or throw an exception if that could not be
- done.
- @li **(1)**--**(3)** is equivalent to
- `this->as_object(loc).at(key, loc)`.
- @li **(4)**--**(6)** is equivalent to
- `this->as_array(loc).at(pos, loc)`.
- @par Complexity
- Constant.
- @par Exception Safety
- Strong guarantee.
- @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 The underlying type of value is not
- the container type corresponding to the first argument (i.e.
- using an index with an @ref object).
- @throw boost::system::system_error An element corresponding to the
- first argument was not found.
- @see @ref as_array, @ref as_object.
- @{
- */
- value&
- at(string_view key, source_location const& loc = BOOST_CURRENT_LOCATION) &
- {
- return as_object(loc).at(key, loc);
- }
- /// Overload
- value&&
- at(string_view key, source_location const& loc = BOOST_CURRENT_LOCATION) &&
- {
- return std::move( as_object(loc) ).at(key, loc);
- }
- /// Overload
- value const&
- at(
- string_view key,
- source_location const& loc = BOOST_CURRENT_LOCATION) const&
- {
- return as_object(loc).at(key, loc);
- }
- /** Overload
- @param pos A zero-based array index.
- @param loc
- */
- value &
- at(std::size_t pos, source_location const& loc = BOOST_CURRENT_LOCATION) &
- {
- return as_array(loc).at(pos, loc);
- }
- /// Overload
- value&&
- at(std::size_t pos, source_location const& loc = BOOST_CURRENT_LOCATION) &&
- {
- return std::move( as_array(loc) ).at(pos, loc);
- }
- /// Overload
- value const&
- at(std::size_t pos,
- source_location const& loc = BOOST_CURRENT_LOCATION) const&
- {
- return as_array(loc).at(pos, loc);
- }
- /// @}
- /** Access an element via JSON Pointer.
- This function is used to access a (potentially nested) element of the
- value using a JSON Pointer string.
- @par Complexity
- Linear in the sizes of `ptr` and underlying array, object, or string.
- @par Exception Safety
- No-throw guarantee.
- @param ptr JSON Pointer string.
- @return @ref boost::system::result containing either a reference to the
- element identified by `ptr` or a corresponding `error_code`.
- @see
- [RFC 6901 - JavaScript Object Notation (JSON) Pointer](https://datatracker.ietf.org/doc/html/rfc6901).
- @{
- */
- BOOST_JSON_DECL
- system::result<value const&>
- try_at_pointer(string_view ptr) const noexcept;
- BOOST_JSON_DECL
- system::result<value&>
- try_at_pointer(string_view ptr) noexcept;
- /// @}
- /** Access an element via JSON Pointer.
- This function is used to access a (potentially nested) element of the
- value using a JSON Pointer string.
- @par Complexity
- Linear in the sizes of `ptr` and the underlying container.
- @par Exception Safety
- Strong guarantee.
- @param ptr JSON Pointer string.
- @param loc @ref boost::source_location to use in thrown exception; the
- source location of the call site by default.
- @return reference to the element identified by `ptr`.
- @throw boost::system::system_error if an error occurs.
- @see
- [RFC 6901 - JavaScript Object Notation (JSON) Pointer](https://datatracker.ietf.org/doc/html/rfc6901).
- @{
- */
- BOOST_JSON_DECL
- value const&
- at_pointer(
- string_view ptr,
- source_location const& loc = BOOST_CURRENT_LOCATION) const&;
- /// Overload
- inline
- value&&
- at_pointer(
- string_view ptr,
- source_location const& loc = BOOST_CURRENT_LOCATION) &&;
- /// Overload
- inline
- value&
- at_pointer(
- string_view ptr,
- source_location const& loc = BOOST_CURRENT_LOCATION) &;
- /// @}
- /** Access an element via JSON Pointer.
- This function is used to access a (potentially nested) element of the
- value using a JSON Pointer string.
- @par Complexity
- Linear in the sizes of `ptr` and underlying container.
- @par Exception Safety
- No-throw guarantee.
- @param ptr JSON Pointer string.
- @param ec Set to the error, if any occurred.
- @return pointer to the element identified by `ptr`.
- @see
- [RFC 6901 - JavaScript Object Notation (JSON) Pointer](https://datatracker.ietf.org/doc/html/rfc6901)
- @{
- */
- BOOST_JSON_DECL
- value const*
- find_pointer(string_view ptr, system::error_code& ec) const noexcept;
- BOOST_JSON_DECL
- value*
- find_pointer(string_view ptr, system::error_code& ec) noexcept;
- BOOST_JSON_DECL
- value const*
- find_pointer(string_view ptr, std::error_code& ec) const noexcept;
- BOOST_JSON_DECL
- value*
- find_pointer(string_view ptr, std::error_code& ec) noexcept;
- /// @}
- //------------------------------------------------------
- /** Set an element via JSON Pointer.
- This function is used to insert or assign to a potentially nested
- element of the value using a JSON Pointer string. The function may
- create intermediate elements corresponding to pointer segments.
- The particular conditions when and what kind of intermediate element
- is created is governed by the `ptr` parameter.
- Each pointer token is considered in sequence. For each token
- - if the containing value is an @ref object, then a new `null`
- element is created with key equal to unescaped token string;
- otherwise
- - if the containing value is an @ref array, and the token represents a
- past-the-end marker, then a `null` element is appended to the array;
- otherwise
- - if the containing value is an @ref array, and the token represents a
- number, then if the difference between the number and array's size
- is smaller than `opts.max_created_elements`, then the size of the
- array is increased, so that the number can reference an element in the
- array; otherwise
- - if the containing value is of different @ref kind and
- `opts.replace_any_scalar` is `true`, or the value is `null`, then
- - if `opts.create_arrays` is `true` and the token either represents
- past-the-end marker or a number, then the value is replaced with
- an empty array and the token is considered again; otherwise
- - if `opts.create_objects` is `true`, then the value is replaced
- with an empty object and the token is considered again; otherwise
- - an error is produced.
- @par Complexity
- Linear in the sum of size of `ptr`, size of underlying array, object,
- or string and `opts.max_created_elements`.
- @par Exception Safety
- Basic guarantee. Calls to `memory_resource::allocate` may throw.
- @param sv JSON Pointer string.
- @param ref The value to assign to pointed element.
- @param opts The options for the algorithm.
- @return @ref boost::system::result containing either a reference to the
- element identified by `ptr` or a corresponding `error_code`.
- @see
- @ref set_pointer_options,
- [RFC 6901 - JavaScript Object Notation (JSON) Pointer](https://datatracker.ietf.org/doc/html/rfc6901).
- */
- BOOST_JSON_DECL
- system::result<value&>
- try_set_at_pointer(
- string_view sv,
- value_ref ref,
- set_pointer_options const& opts = {} );
- /** Set an element via JSON Pointer.
- This function is used to insert or assign to a potentially nested
- element of the value using a JSON Pointer string. The function may
- create intermediate elements corresponding to pointer segments.
- The particular conditions when and what kind of intermediate element
- is created is governed by the `ptr` parameter.
- Each pointer token is considered in sequence. For each token
- - if the containing value is an @ref object, then a new `null`
- element is created with key equal to unescaped token string; otherwise
- - if the containing value is an @ref array, and the token represents a
- past-the-end marker, then a `null` element is appended to the array;
- otherwise
- - if the containing value is an @ref array, and the token represents a
- number, then if the difference between the number and array's size
- is smaller than `opts.max_created_elements`, then the size of the
- array is increased, so that the number can reference an element in the
- array; otherwise
- - if the containing value is of different @ref kind and
- `opts.replace_any_scalar` is `true`, or the value is `null`, then
- - if `opts.create_arrays` is `true` and the token either represents
- past-the-end marker or a number, then the value is replaced with
- an empty array and the token is considered again; otherwise
- - if `opts.create_objects` is `true`, then the value is replaced
- with an empty object and the token is considered again; otherwise
- - an error is produced.
- @par Complexity
- Linear in the sum of size of `ptr`, size of underlying array, object,
- or string and `opts.max_created_elements`.
- @par Exception Safety
- Basic guarantee.
- Calls to `memory_resource::allocate` may throw.
- @param sv JSON Pointer string.
- @param ref The value to assign to pointed element.
- @param opts The options for the algorithm.
- @return Reference to the element identified by `ptr`.
- @throws boost::system::system_error Overload **(1)** reports errors by
- throwing exceptions.
- @see @ref set_pointer_options,
- [RFC 6901 - JavaScript Object Notation (JSON) Pointer](https://datatracker.ietf.org/doc/html/rfc6901">).
- @{
- */
- BOOST_JSON_DECL
- value&
- set_at_pointer(
- string_view sv,
- value_ref ref,
- set_pointer_options const& opts = {} );
- /** Overload
- @param ec Set to the error, if any occurred.
- @param sv
- @param ref
- @param opts
- */
- BOOST_JSON_DECL
- value*
- set_at_pointer(
- string_view sv,
- value_ref ref,
- system::error_code& ec,
- set_pointer_options const& opts = {} );
- /// Overload
- BOOST_JSON_DECL
- value*
- set_at_pointer(
- string_view sv,
- value_ref ref,
- std::error_code& ec,
- set_pointer_options const& opts = {} );
- /// @}
- //------------------------------------------------------
- /** Check if two values are equal.
- Two values are equal when they are the same kind and their referenced
- values are equal, or when they are both integral types and their
- integral representations are equal.
- @par Complexity
- Constant or linear in the size of the underlying @ref array, @ref object,
- or @ref string.
- @par Exception Safety
- No-throw guarantee.
- */
- // inline friend speeds up overload resolution
- friend
- bool
- operator==(
- value const& lhs,
- value const& rhs) noexcept
- {
- return lhs.equal(rhs);
- }
- /** Check if two values are not equal.
- Two values are equal when they are the same kind and their referenced
- values are equal, or when they are both integral types and their
- integral representations are equal.
- @par Complexity
- Constant or linear in the size of the underlying @ref array,
- @ref object, or @ref string.
- @par Exception Safety
- No-throw guarantee.
- */
- friend
- bool
- operator!=(
- value const& lhs,
- value const& rhs) noexcept
- {
- return ! (lhs == rhs);
- }
- /** Serialize @ref value to an output stream.
- This function serializes a `value` as JSON text into the output stream.
- @return Reference to `os`.
- @par Complexity
- Constant or linear in the size of `jv`.
- @par Exception Safety
- Strong guarantee.
- Calls to `memory_resource::allocate` may throw.
- @param os The output stream to serialize to.
- @param jv The value to serialize.
- */
- BOOST_JSON_DECL
- friend
- std::ostream&
- operator<<(
- std::ostream& os,
- value const& jv);
- /** Parse @ref value from an input stream.
- This function parses JSON from an input stream into a `value`. If
- parsing fails, @ref std::ios_base::failbit will be set for `is` and
- `jv` will be left unchanged. Regardless of whether @ref
- std::ios_base::skipws flag is set on `is`, consumes whitespace before
- and after JSON, because whitespace is considered a part of JSON.
- Behaves as
- [_FormattedInputFunction_](https://en.cppreference.com/w/cpp/named_req/FormattedInputFunction).
- @note This operator cannot assume that the stream only contains a
- single JSON document, which may result in **very underwhelming
- performance**, if the stream isn't cooperative. If you know that your
- input consists of a single JSON document, consider using @ref parse
- function instead.
- @return Reference to `is`.
- @par Complexity
- Linear in the size of JSON data.
- @par Exception Safety
- Basic guarantee.
- Calls to `memory_resource::allocate` may throw.
- The stream may throw as configured by @ref std::ios::exceptions.
- @param is The input stream to parse from.
- @param jv The value to parse into.
- @see @ref parse.
- */
- BOOST_JSON_DECL
- friend
- std::istream&
- operator>>(
- std::istream& is,
- value& jv);
- /** Helper for @ref boost::hash support.
- Computes a hash value for `jv`. This function is used by
- `boost::hash<value>`. Similar overloads for @ref array, @ref object,
- and @ref string do not exist, because those types are supported by
- `boost::hash` out of the box.
- @return hash value for `jv`.
- @param jv `value` for which a hash is to be computed.
- @see [Boost.ContainerHash](https://boost.org/libs/container_hash).
- */
- #ifndef BOOST_JSON_DOCS
- template<
- class T,
- typename std::enable_if<
- std::is_same< detail::remove_cvref<T>, value >::value >::type*
- = nullptr>
- friend
- std::size_t
- hash_value( T const& jv ) noexcept
- #else
- friend
- inline
- std::size_t
- hash_value( value const& jv ) noexcept
- #endif
- {
- return detail::hash_value_impl(jv);
- }
- private:
- static
- void
- relocate(
- value* dest,
- value const& src) noexcept
- {
- std::memcpy(
- static_cast<void*>(dest),
- &src,
- sizeof(src));
- }
- BOOST_JSON_DECL
- storage_ptr
- destroy() noexcept;
- BOOST_JSON_DECL
- bool
- equal(value const& other) const noexcept;
- template<class T>
- auto
- to_number(error& e) const noexcept ->
- typename std::enable_if<
- std::is_signed<T>::value &&
- ! std::is_floating_point<T>::value,
- T>::type
- {
- if(sca_.k == json::kind::int64)
- {
- auto const i = sca_.i;
- if( i >= (std::numeric_limits<T>::min)() &&
- i <= (std::numeric_limits<T>::max)())
- {
- e = {};
- return static_cast<T>(i);
- }
- e = error::not_exact;
- }
- else if(sca_.k == json::kind::uint64)
- {
- auto const u = sca_.u;
- if(u <= static_cast<std::uint64_t>((
- std::numeric_limits<T>::max)()))
- {
- e = {};
- return static_cast<T>(u);
- }
- e = error::not_exact;
- }
- else if(sca_.k == json::kind::double_)
- {
- auto const d = sca_.d;
- if( d >= static_cast<double>(
- (detail::to_number_limit<T>::min)()) &&
- d <= static_cast<double>(
- (detail::to_number_limit<T>::max)()) &&
- static_cast<T>(d) == d)
- {
- e = {};
- return static_cast<T>(d);
- }
- e = error::not_exact;
- }
- else
- {
- e = error::not_number;
- }
- return T{};
- }
- template<class T>
- auto
- to_number(error& e) const noexcept ->
- typename std::enable_if<
- std::is_unsigned<T>::value &&
- ! std::is_same<T, bool>::value,
- T>::type
- {
- if(sca_.k == json::kind::int64)
- {
- auto const i = sca_.i;
- if( i >= 0 && static_cast<std::uint64_t>(i) <=
- (std::numeric_limits<T>::max)())
- {
- e = {};
- return static_cast<T>(i);
- }
- e = error::not_exact;
- }
- else if(sca_.k == json::kind::uint64)
- {
- auto const u = sca_.u;
- if(u <= (std::numeric_limits<T>::max)())
- {
- e = {};
- return static_cast<T>(u);
- }
- e = error::not_exact;
- }
- else if(sca_.k == json::kind::double_)
- {
- auto const d = sca_.d;
- if( d >= 0 &&
- d <= (detail::to_number_limit<T>::max)() &&
- static_cast<T>(d) == d)
- {
- e = {};
- return static_cast<T>(d);
- }
- e = error::not_exact;
- }
- else
- {
- e = error::not_number;
- }
- return T{};
- }
- template<class T>
- auto
- to_number(error& e) const noexcept ->
- typename std::enable_if<
- std::is_floating_point<
- T>::value, T>::type
- {
- if(sca_.k == json::kind::int64)
- {
- e = {};
- return static_cast<T>(sca_.i);
- }
- if(sca_.k == json::kind::uint64)
- {
- e = {};
- return static_cast<T>(sca_.u);
- }
- if(sca_.k == json::kind::double_)
- {
- e = {};
- return static_cast<T>(sca_.d);
- }
- e = error::not_number;
- return {};
- }
- };
- // Make sure things are as big as we think they should be
- #if BOOST_JSON_ARCH == 64
- BOOST_CORE_STATIC_ASSERT( sizeof(value) == 24 );
- #elif BOOST_JSON_ARCH == 32
- BOOST_CORE_STATIC_ASSERT( sizeof(value) == 16 );
- #else
- # error Unknown architecture
- #endif
- //----------------------------------------------------------
- /** A key/value pair.
- This is the type of element used by the @ref object container.
- */
- class key_value_pair
- {
- #ifndef BOOST_JSON_DOCS
- friend struct detail::access;
- using access = detail::access;
- #endif
- BOOST_JSON_DECL
- static char const empty_[1];
- inline
- key_value_pair(
- pilfered<json::value> k,
- pilfered<json::value> v) noexcept;
- public:
- /** Assignment
- This type is not copy or move-assignable. The copy assignment operator
- is deleted.
- */
- key_value_pair&
- operator=(key_value_pair const&) = delete;
- /** Destructor.
- The value is destroyed and all internally allocated memory is freed.
- */
- ~key_value_pair() noexcept
- {
- auto const& sp = value_.storage();
- if(sp.is_not_shared_and_deallocate_is_trivial())
- return;
- if(key_ == empty_)
- return;
- sp->deallocate(const_cast<char*>(key_),
- len_ + 1, alignof(char));
- }
- /** Constructors.
- Construct a key/value pair.
- @li **(1)** uses a copy of the characters of `key`, and constructs the
- value as if by `value(std::forward<Args>(args)...)`.
- @li **(2)** equivalent to `key_value_pair(p.first, p.second, sp)`.
- @li **(3)** equivalent to
- `key_value_pair(p.first, std::move(p.second), sp)`.
- @li **(4)** equivalent to
- `key_value_pair(other.key(), other.value(), sp)`.
- @li **(5)** equivalent to
- `key_value_pair(other.key(), other.value(), other.storage())`.
- @li **(6)** the pair s constructed by acquiring ownership of the
- contents of `other` using move semantics.
- @li **(7)** the pair is constructed by acquiring 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.
- With **(2)**, **(3)**, **(4)** the pair uses the memory resource of
- `sp`. With **(5)**, **(6)**, **(7)** it uses the memory resource of
- `other.storage()`. With **(1)** it uses whatever memory resource
- `value(std::forward<Args>(args)...)` would use. In any case the pair
- acquires shared ownership of its memory resource
- After **(6)** `other` holds an empty key, and a null value with its
- current storage pointer.
- After **(7)** `other` is not in a usable state and may only be destroyed.
- @par Complexity
- Constant.
- @par Exception Safety
- Strong guarantee. Calls to `memory_resource::allocate` may throw.
- @param key The key string to use.
- @param args Optional arguments forwarded to the @ref value constructor.
- @throw boost::system::system_error The size of the key would exceed
- @ref string::max_size.
- @see @ref pilfer,
- [Valueless Variants Considered Harmful](http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2016/p0308r0.html).
- @{
- */
- template<class... Args>
- explicit
- key_value_pair(
- string_view key,
- Args&&... args)
- : value_(std::forward<Args>(args)...)
- {
- if(key.size() > string::max_size())
- {
- BOOST_STATIC_CONSTEXPR source_location loc = BOOST_CURRENT_LOCATION;
- detail::throw_system_error( error::key_too_large, &loc );
- }
- auto s = reinterpret_cast<
- char*>(value_.storage()->
- allocate(key.size() + 1, alignof(char)));
- std::memcpy(s, key.data(), key.size());
- s[key.size()] = 0;
- key_ = s;
- len_ = static_cast<
- std::uint32_t>(key.size());
- }
- /** Overload
- @param p A `std::pair` with the key string and @ref value to construct
- with.
- @param sp A pointer to the @ref boost::container::pmr::memory_resource
- to use.
- */
- explicit
- key_value_pair(
- std::pair<
- string_view,
- json::value> const& p,
- storage_ptr sp = {})
- : key_value_pair(
- p.first,
- p.second,
- std::move(sp))
- {
- }
- /// Overload
- explicit
- key_value_pair(
- std::pair<
- string_view,
- json::value>&& p,
- storage_ptr sp = {})
- : key_value_pair(
- p.first,
- std::move(p).second,
- std::move(sp))
- {
- }
- /** Overload
- @param other Another key/value pair.
- @param sp
- */
- BOOST_JSON_DECL
- key_value_pair(
- key_value_pair const& other,
- storage_ptr sp);
- /// Overload
- key_value_pair(
- key_value_pair const& other)
- : key_value_pair(other,
- other.storage())
- {
- }
- /// Overload
- key_value_pair(
- key_value_pair&& other) noexcept
- : value_(std::move(other.value_))
- , key_(detail::exchange(
- other.key_, empty_))
- , len_(detail::exchange(
- other.len_, 0))
- {
- }
- /// Overload
- key_value_pair(
- pilfered<key_value_pair> other) noexcept
- : value_(pilfer(other.get().value_))
- , key_(detail::exchange(
- other.get().key_, empty_))
- , len_(detail::exchange(
- other.get().len_, 0))
- {
- }
- /// @}
- /** The associated memory resource.
- Returns a pointer to the memory resource used to construct the value.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- storage_ptr const&
- storage() const noexcept
- {
- return value_.storage();
- }
- /** The pair's key.
- After construction, the key may not be modified.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- string_view const
- key() const noexcept
- {
- return { key_, len_ };
- }
- /** The pair's key as a null-terminated string.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- */
- char const*
- key_c_str() const noexcept
- {
- return key_;
- }
- /** The pair's value.
- @par Complexity
- Constant.
- @par Exception Safety
- No-throw guarantee.
- @{
- */
- json::value const&
- value() const& noexcept
- {
- return value_;
- }
- json::value&&
- value() && noexcept
- {
- return std::move( value() );
- }
- json::value&
- value() & noexcept
- {
- return value_;
- }
- /// @}
- private:
- json::value value_;
- char const* key_;
- std::uint32_t len_;
- std::uint32_t next_;
- };
- //----------------------------------------------------------
- #ifdef BOOST_JSON_DOCS
- /** Tuple-like element access.
- This overload of `get` permits the key and value of a @ref key_value_pair
- to be accessed by index. For example:
- @code
- key_value_pair kvp("num", 42);
- string_view key = get<0>(kvp);
- value& jv = get<1>(kvp);
- @endcode
- @par Structured Bindings
- When using C++17 or greater, objects of type @ref key_value_pair may be
- used to initialize structured bindings:
- @code
- key_value_pair kvp("num", 42);
- auto& [key, value] = kvp;
- @endcode
- Depending on the value of `I`, the return type will be:
- @li `string_view const` if `I == 0`, or
- @li `value&`, `value const&`, or `value&&` if `I == 1`.
- Using any other value for `I` is ill-formed.
- @par Constraints
- `std::is_same_v< std::remove_cvref_t<T>, key_value_pair >`
- @tparam I The element index to access.
- @return `kvp.key()` if `I == 0`, or `kvp.value()` if `I == 1`.
- @param kvp The @ref key_value_pair object to access.
- */
- template<
- std::size_t I,
- class T>
- __see_below__
- get(T&& kvp) noexcept;
- #else
- template<std::size_t I>
- auto
- get(key_value_pair const&) noexcept ->
- typename std::conditional<I == 0,
- string_view const,
- value const&>::type
- {
- static_assert(I == 0,
- "key_value_pair index out of range");
- }
- template<std::size_t I>
- auto
- get(key_value_pair&) noexcept ->
- typename std::conditional<I == 0,
- string_view const,
- value&>::type
- {
- static_assert(I == 0,
- "key_value_pair index out of range");
- }
- template<std::size_t I>
- auto
- get(key_value_pair&&) noexcept ->
- typename std::conditional<I == 0,
- string_view const,
- value&&>::type
- {
- static_assert(I == 0,
- "key_value_pair index out of range");
- }
- /** Extracts a key_value_pair's key using tuple-like interface
- */
- template<>
- inline
- string_view const
- get<0>(key_value_pair const& kvp) noexcept
- {
- return kvp.key();
- }
- /** Extracts a key_value_pair's key using tuple-like interface
- */
- template<>
- inline
- string_view const
- get<0>(key_value_pair& kvp) noexcept
- {
- return kvp.key();
- }
- /** Extracts a key_value_pair's key using tuple-like interface
- */
- template<>
- inline
- string_view const
- get<0>(key_value_pair&& kvp) noexcept
- {
- return kvp.key();
- }
- /** Extracts a key_value_pair's value using tuple-like interface
- */
- template<>
- inline
- value const&
- get<1>(key_value_pair const& kvp) noexcept
- {
- return kvp.value();
- }
- /** Extracts a key_value_pair's value using tuple-like interface
- */
- template<>
- inline
- value&
- get<1>(key_value_pair& kvp) noexcept
- {
- return kvp.value();
- }
- /** Extracts a key_value_pair's value using tuple-like interface
- */
- template<>
- inline
- value&&
- get<1>(key_value_pair&& kvp) noexcept
- {
- return std::move(kvp.value());
- }
- #endif
- } // namespace json
- } // namespace boost
- #ifdef __clang__
- # pragma clang diagnostic push
- # pragma clang diagnostic ignored "-Wmismatched-tags"
- #endif
- #ifndef BOOST_JSON_DOCS
- namespace std {
- /** Tuple-like size access for key_value_pair
- */
- template<>
- struct tuple_size< ::boost::json::key_value_pair >
- : std::integral_constant<std::size_t, 2>
- {
- };
- /** Tuple-like access for the key type of key_value_pair
- */
- template<>
- struct tuple_element<0, ::boost::json::key_value_pair>
- {
- using type = ::boost::json::string_view const;
- };
- /** Tuple-like access for the value type of key_value_pair
- */
- template<>
- struct tuple_element<1, ::boost::json::key_value_pair>
- {
- using type = ::boost::json::value&;
- };
- /** Tuple-like access for the value type of key_value_pair
- */
- template<>
- struct tuple_element<1, ::boost::json::key_value_pair const>
- {
- using type = ::boost::json::value const&;
- };
- } // std
- #endif
- // std::hash specialization
- #ifndef BOOST_JSON_DOCS
- namespace std {
- template <>
- struct hash< ::boost::json::value > {
- BOOST_JSON_DECL
- std::size_t
- operator()(::boost::json::value const& jv) const noexcept;
- };
- } // std
- #endif
- #ifdef __clang__
- # pragma clang diagnostic pop
- #endif
- // These are here because value, array,
- // and object form cyclic references.
- #include <boost/json/detail/impl/array.hpp>
- #include <boost/json/impl/array.hpp>
- #include <boost/json/impl/object.hpp>
- #include <boost/json/impl/value.hpp>
- // These must come after array and object
- #include <boost/json/impl/value_ref.hpp>
- #endif
|