2023-11-26 16:01:20 +03:00
<!doctype html> < html lang = en class = no-js > < head > < meta charset = utf-8 > < meta name = viewport content = "width=device-width,initial-scale=1" > < meta name = author content = "Niels Lohmann" > < link href = https://json.nlohmann.me/api/basic_json/from_msgpack/ rel = canonical > < link href = ../from_cbor/ rel = prev > < link href = ../from_ubjson/ rel = next > < link rel = icon href = ../../../assets/images/favicon.png > < meta name = generator content = "mkdocs-1.5.3, mkdocs-material-9.4.7" > < title > from_msgpack - JSON for Modern C++< / title > < link rel = stylesheet href = ../../../assets/stylesheets/main.4b4a2bd9.min.css > < link rel = stylesheet href = ../../../assets/stylesheets/palette.356b1318.min.css > < link rel = preconnect href = https://fonts.gstatic.com crossorigin > < link rel = stylesheet href = "https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback" > < style > : root { --md-text-font : "Roboto" ; --md-code-font : "JetBrains Mono" } < / style > < link rel = stylesheet href = ../../../css/custom.css > < script > _ _md _scope = new URL ( "../../.." , location ) , _ _md _hash = e => [ ... e ] . reduce ( ( e , _ ) => ( e << 5 ) - e + _ . charCodeAt ( 0 ) , 0 ) , _ _md _get = ( e , _ = localStorage , t = _ _md _scope ) => JSON . parse ( _ . getItem ( t . pathname + "." + e ) ) , _ _md _set = ( e , _ , t = localStorage , a = _ _md _scope ) => { try { t . setItem ( a . pathname + "." + e , JSON . stringify ( _ ) ) } catch ( e ) { } } < / script > < / head > < body dir = ltr data-md-color-scheme = default data-md-color-primary = indigo data-md-color-accent = indigo > < script > var palette = _ _md _get ( "__palette" ) ; if ( palette && "object" == typeof palette . color ) for ( var key of Object . keys ( palette . color ) ) document . body . setAttribute ( "data-md-color-" + key , palette . color [ key ] ) < / script > < input class = md-toggle data-md-toggle = drawer type = checkbox id = __drawer autocomplete = off > < input class = md-toggle data-md-toggle = search type = checkbox id = __search autocomplete = off > < label class = md-overlay for = __drawer > < / label > < div data-md-component = skip > < a href = #nlohmannbasic_jsonfrom_msgpack class = md-skip > Skip to content < / a > < / div > < div data-md-component = announce > < / div > < header class = md-header data-md-component = header > < nav class = "md-header__inner md-grid" aria-label = Header > < a href = ../../.. title = "JSON for Modern C++" class = "md-header__button md-logo" aria-label = "JSON for Modern C++" data-md-component = logo > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z" / > < / svg > < / a > < label class = "md-header__button md-icon" for = __drawer > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z" / > < / svg > < / label > < div class = md-header__title data-md-component = header-title > < div class = md-header__ellipsis > < div class = md-header__topic > < span class = md-ellipsis > JSON for Modern C++ < / span > < / div > < div class = md-header__topic data-md-component = header-topic > < span class = md-ellipsis > from_msgpack < / span > < / div > < / div > < / div > < form class = md-header__option data-md-component = palette > < input class = md-option data-md-color-media = "(prefers-color-scheme: light)" data-md-color-scheme = default data-md-color-primary = indigo data-md-color-accent = indigo aria-label = "Switch to dark mode" type = radio name = __palette id = __palette_1 > < label class = "md-header__button md-icon" title = "Switch to dark mode" for = __palette_2 hidden > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z" / > < / svg > < / label > < input class = md-option data-md-color-media = "(prefers-color-scheme: dark)" data-md-color-scheme = slate data-md-color-primary = indigo data-md-color-accent = indigo aria-label = "Switch to light mode" type = radio name = __palette id = __palette_2 > < label class = "md-header__button md-icon" title = "Switch to light mode" for = __palette_1 hidden > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M12 18c- . 89 0-1 . 74- . 2-2 . 5- . 5
< span class = k > template< / span > < span class = o > < < / span > < span class = k > typename< / span > < span class = w > < / span > < span class = nc > InputType< / span > < span class = o > > < / span >
< span class = k > static< / span > < span class = w > < / span > < span class = n > basic_json< / span > < span class = w > < / span > < span class = n > from_msgpack< / span > < span class = p > (< / span > < span class = n > InputType< / span > < span class = o > & & < / span > < span class = w > < / span > < span class = n > i< / span > < span class = p > ,< / span >
< span class = w > < / span > < span class = k > const< / span > < span class = w > < / span > < span class = kt > bool< / span > < span class = w > < / span > < span class = n > strict< / span > < span class = w > < / span > < span class = o > =< / span > < span class = w > < / span > < span class = nb > true< / span > < span class = p > ,< / span >
< span class = w > < / span > < span class = k > const< / span > < span class = w > < / span > < span class = kt > bool< / span > < span class = w > < / span > < span class = n > allow_exceptions< / span > < span class = w > < / span > < span class = o > =< / span > < span class = w > < / span > < span class = nb > true< / span > < span class = p > );< / span >
2023-03-08 15:43:29 +03:00
< span class = c1 > // (2)< / span >
2023-11-26 16:01:20 +03:00
< span class = k > template< / span > < span class = o > < < / span > < span class = k > typename< / span > < span class = w > < / span > < span class = nc > IteratorType< / span > < span class = o > > < / span >
< span class = k > static< / span > < span class = w > < / span > < span class = n > basic_json< / span > < span class = w > < / span > < span class = n > from_msgpack< / span > < span class = p > (< / span > < span class = n > IteratorType< / span > < span class = w > < / span > < span class = n > first< / span > < span class = p > ,< / span > < span class = w > < / span > < span class = n > IteratorType< / span > < span class = w > < / span > < span class = n > last< / span > < span class = p > ,< / span >
< span class = w > < / span > < span class = k > const< / span > < span class = w > < / span > < span class = kt > bool< / span > < span class = w > < / span > < span class = n > strict< / span > < span class = w > < / span > < span class = o > =< / span > < span class = w > < / span > < span class = nb > true< / span > < span class = p > ,< / span >
< span class = w > < / span > < span class = k > const< / span > < span class = w > < / span > < span class = kt > bool< / span > < span class = w > < / span > < span class = n > allow_exceptions< / span > < span class = w > < / span > < span class = o > =< / span > < span class = w > < / span > < span class = nb > true< / span > < span class = p > );< / span >
< / code > < / pre > < / div > < p > Deserializes a given input to a JSON value using the MessagePack serialization format.< / p > < ol > < li > Reads from a compatible input.< / li > < li > Reads from an iterator range.< / li > < / ol > < p > The exact mapping and its limitations is described on a < a href = ../../../features/binary_formats/messagepack/ > dedicated page< / a > .< / p > < h2 id = template-parameters > Template parameters< a class = headerlink href = #template-parameters title = "Permanent link" > ¶ < / a > < / h2 > < dl > < dt > < code > InputType< / code > < / dt > < dd > < p > A compatible input, for instance:< / p > < ul > < li > an < code > std::istream< / code > object< / li > < li > a < code > FILE< / code > pointer< / li > < li > a C-style array of characters< / li > < li > a pointer to a null-terminated string of single byte characters< / li > < li > an object < code > obj< / code > for which < code > begin(obj)< / code > and < code > end(obj)< / code > produces a valid pair of iterators.< / li > < / ul > < / dd > < dt > < code > IteratorType< / code > < / dt > < dd > a compatible iterator type< / dd > < / dl > < h2 id = parameters > Parameters< a class = headerlink href = #parameters title = "Permanent link" > ¶ < / a > < / h2 > < dl > < dt > < code > i< / code > (in)< / dt > < dd > an input in MessagePack format convertible to an input adapter< / dd > < dt > < code > first< / code > (in)< / dt > < dd > iterator to start of the input< / dd > < dt > < code > last< / code > (in)< / dt > < dd > iterator to end of the input< / dd > < dt > < code > strict< / code > (in)< / dt > < dd > whether to expect the input to be consumed until EOF (< code class = highlight > < span class = nb > true< / span > < / code > by default)< / dd > < dt > < code > allow_exceptions< / code > (in)< / dt > < dd > whether to throw exceptions in case of a parse error (optional, < code class = highlight > < span class = nb > true< / span > < / code > by default)< / dd > < / dl > < h2 id = return-value > Return value< a class = headerlink href = #return-value title = "Permanent link" > ¶ < / a > < / h2 > < p > deserialized JSON value; in case of a parse error and < code > allow_exceptions< / code > set to < code class = highlight > < span class = nb > false< / span > < / code > , the return value will be < code > value_t::discarded< / code > . The latter can be checked with < a href = ../is_discarded/ > < code > is_discarded< / code > < / a > .< / p > < h2 id = exception-safety > Exception safety< a class = headerlink href = #exception-safety title = "Permanent link" > ¶ < / a > < / h2 > < p > Strong guarantee: if an exception is thrown, there are no changes in the JSON value.< / p > < h2 id = exceptions > Exceptions< a class = headerlink href = #exceptions title = "Permanent link" > ¶ < / a > < / h2 > < ul > < li > Throws < a href = ../../../home/exceptions/#jsonexceptionparse_error110 > parse_error.110< / a > if the given input ends prematurely or the end of file was not reached when < code > strict< / code > was set to true< / li > < li > Throws < a href = ../../../home/exceptions/#jsonexceptionparse_error112 > parse_error.112< / a > if unsupported features from MessagePack were used in the given input or if the input is not valid MessagePack< / li > < li > Throws < a href = ../../../home/exceptions/#jsonexceptionparse_error113 > parse_error.113< / a > if a string was expected as map key, but not found< / li > < / ul > < h2 id = complexity > Complexity< a class = headerlink href = #complexity title = "Permanent link" > ¶ < / a > < / h2 > < p > Linear in the size of the input.< / p > < h2 id = examples > Examples< a class = headerlink href = #examples title = "Permanent link" > ¶ < / a > < / h2 > < details class = example > < summary > Example< / summary > < p > The example shows the deserialization of a byte vector in MessagePack format to a JSON value.< / p > < div class = highlight > < pre > < span > < / span > < code > < span class = cp > #include< / span > < span class = w > < / span > < span class = cpf > < iostream> < / span >
< span class = cp > #include< / span > < span class = w > < / span > < span class = cpf > < iomanip> < / span >
< span class = cp > #include< / span > < span class = w > < / span > < span class = cpf > < nlohmann/json.hpp> < / span >
2023-03-08 15:43:29 +03:00
2023-11-26 16:01:20 +03:00
< span class = k > using< / span > < span class = w > < / span > < span class = n > json< / span > < span class = w > < / span > < span class = o > =< / span > < span class = w > < / span > < span class = n > nlohmann< / span > < span class = o > ::< / span > < span class = n > json< / span > < span class = p > ;< / span >
2023-03-08 15:43:29 +03:00
2023-11-26 16:01:20 +03:00
< span class = kt > int< / span > < span class = w > < / span > < span class = nf > main< / span > < span class = p > ()< / span >
< span class = p > {< / span >
2023-03-08 15:43:29 +03:00
< span class = w > < / span > < span class = c1 > // create byte vector< / span >
2023-11-26 16:01:20 +03:00
< span class = w > < / span > < span class = n > std< / span > < span class = o > ::< / span > < span class = n > vector< / span > < span class = o > < < / span > < span class = n > std< / span > < span class = o > ::< / span > < span class = kt > uint8_t< / span > < span class = o > > < / span > < span class = w > < / span > < span class = n > v< / span > < span class = w > < / span > < span class = o > =< / span > < span class = w > < / span > < span class = p > {< / span > < span class = mh > 0x82< / span > < span class = p > ,< / span > < span class = w > < / span > < span class = mh > 0xa7< / span > < span class = p > ,< / span > < span class = w > < / span > < span class = mh > 0x63< / span > < span class = p > ,< / span > < span class = w > < / span > < span class = mh > 0x6f< / span > < span class = p > ,< / span > < span class = w > < / span > < span class = mh > 0x6d< / span > < span class = p > ,< / span > < span class = w > < / span > < span class = mh > 0x70< / span > < span class = p > ,< / span > < span class = w > < / span > < span class = mh > 0x61< / span > < span class = p > ,< / span > < span class = w > < / span > < span class = mh > 0x63< / span > < span class = p > ,< / span >
< span class = w > < / span > < span class = mh > 0x74< / span > < span class = p > ,< / span > < span class = w > < / span > < span class = mh > 0xc3< / span > < span class = p > ,< / span > < span class = w > < / span > < span class = mh > 0xa6< / span > < span class = p > ,< / span > < span class = w > < / span > < span class = mh > 0x73< / span > < span class = p > ,< / span > < span class = w > < / span > < span class = mh > 0x63< / span > < span class = p > ,< / span > < span class = w > < / span > < span class = mh > 0x68< / span > < span class = p > ,< / span > < span class = w > < / span > < span class = mh > 0x65< / span > < span class = p > ,< / span > < span class = w > < / span > < span class = mh > 0x6d< / span > < span class = p > ,< / span >
< span class = w > < / span > < span class = mh > 0x61< / span > < span class = p > ,< / span > < span class = w > < / span > < span class = mh > 0x00< / span >
< span class = w > < / span > < span class = p > };< / span >
2023-03-08 15:43:29 +03:00
< span class = w > < / span > < span class = c1 > // deserialize it with MessagePack< / span >
2023-11-26 16:01:20 +03:00
< span class = w > < / span > < span class = n > json< / span > < span class = w > < / span > < span class = n > j< / span > < span class = w > < / span > < span class = o > =< / span > < span class = w > < / span > < span class = n > json< / span > < span class = o > ::< / span > < span class = n > from_msgpack< / span > < span class = p > (< / span > < span class = n > v< / span > < span class = p > );< / span >
2023-03-08 15:43:29 +03:00
< span class = w > < / span > < span class = c1 > // print the deserialized JSON value< / span >
2023-11-26 16:01:20 +03:00
< span class = w > < / span > < span class = n > std< / span > < span class = o > ::< / span > < span class = n > cout< / span > < span class = w > < / span > < span class = o > < < < / span > < span class = w > < / span > < span class = n > std< / span > < span class = o > ::< / span > < span class = n > setw< / span > < span class = p > (< / span > < span class = mi > 2< / span > < span class = p > )< / span > < span class = w > < / span > < span class = o > < < < / span > < span class = w > < / span > < span class = n > j< / span > < span class = w > < / span > < span class = o > < < < / span > < span class = w > < / span > < span class = n > std< / span > < span class = o > ::< / span > < span class = n > endl< / span > < span class = p > ;< / span >
< span class = p > }< / span >
< / code > < / pre > < / div > < p > Output:< / p > < div class = highlight > < pre > < span > < / span > < code > < span class = p > {< / span >
< span class = w > < / span > < span class = nt > " compact" < / span > < span class = p > :< / span > < span class = w > < / span > < span class = kc > true< / span > < span class = p > ,< / span >
< span class = w > < / span > < span class = nt > " schema" < / span > < span class = p > :< / span > < span class = w > < / span > < span class = mi > 0< / span >
< span class = p > }< / span >
< / code > < / pre > < / div > < / details > < h2 id = version-history > Version history< a class = headerlink href = #version-history title = "Permanent link" > ¶ < / a > < / h2 > < ul > < li > Added in version 2.0.9.< / li > < li > Parameter < code > start_index< / code > since version 2.1.1.< / li > < li > Changed to consume input adapters, removed < code > start_index< / code > parameter, and added < code > strict< / code > parameter in version 3.0.0.< / li > < li > Added < code > allow_exceptions< / code > parameter in version 3.2.0.< / li > < / ul > < div class = "admonition warning" > < p class = admonition-title > Deprecation< / p > < ul > < li > Overload (2) replaces calls to < code > from_msgpack< / code > with a pointer and a length as first two parameters, which has been deprecated in version 3.8.0. This overload will be removed in version 4.0.0. Please replace all calls like < code class = highlight > < span class = n > from_msgpack< / span > < span class = p > (< / span > < span class = n > ptr< / span > < span class = p > ,< / span > < span class = w > < / span > < span class = n > len< / span > < span class = p > ,< / span > < span class = w > < / span > < span class = p > ...);< / span > < / code > with < code class = highlight > < span class = n > from_msgpack< / span > < span class = p > (< / span > < span class = n > ptr< / span > < span class = p > ,< / span > < span class = w > < / span > < span class = n > ptr< / span > < span class = o > +< / span > < span class = n > len< / span > < span class = p > ,< / span > < span class = w > < / span > < span class = p > ...);< / span > < / code > .< / li > < li > Overload (2) replaces calls to < code > from_cbor< / code > with a pair of iterators as their first parameter, which has been deprecated in version 3.8.0. This overload will be removed in version 4.0.0. Please replace all calls like < code class = highlight > < span class = n > from_msgpack< / span > < span class = p > ({< / span > < span class = n > ptr< / span > < span class = p > ,< / span > < span class = w > < / span > < span class = n > ptr< / span > < span class = o > +< / span > < span class = n > len< / span > < span class = p > },< / span > < span class = w > < / span > < span class = p > ...);< / span > < / code > with < code class = highlight > < span class = n > from_msgpack< / span > < span class = p > (< / span > < span class = n > ptr< / span > < span class = p > ,< / span > < span class = w > < / span > < span class = n > ptr< / span > < span class = o > +< / span > < span class = n > len< / span > < span class = p > ,< / span > < span class = w > < / span > < span class = p > ...);< / span > < / code > .< / li > < / ul > < p > You should be warned by your compiler with a < code > -Wdeprecated-declarations< / code > warning if you are using a deprecated function.< / p > < / div > < hr > < div class = md-source-file > < small > Last update: < span class = "git-revision-date-localized-plugin git-revision-date-localized-plugin-date" > May 1, 2022< / span > < / small > < / div > < / article > < / div > < script > var tabs = _ _md _get ( "__tabs" ) ; if ( Array . isArray ( tabs ) ) e : for ( var set of document . querySelectorAll ( ".tabbed-set" ) ) { var tab , labels = set . querySelector ( ".tabbed-labels" ) ; for ( tab of tabs ) for ( var label of labels . getElementsByTagName ( "label" ) ) if ( label . innerText . trim ( ) === tab ) { var input = document . getElementById ( label . htmlFor ) ; input . checked = ! 0 ; continue e } } < / script > < / div > < button type = button class = "md-top md-icon" data-md-component = top hidden > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z" / > < / svg > Back to top < / button > < / main > < footer class = md-footer > < div class = "md-footer-meta md-typeset" > < div class = "md-footer-meta__inner md-grid" > < div class = md-copyright > < div class = md-copyright__highlight > Copyright © 2013 - 2023 Niels Lohmann < / div > < / div > < div class = md-social > < a href = https://github.com/nlohmann target = _blank rel = noopener title = github.com class = md-social__link > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 496 512" > <!-- Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc. --> < path d = "M165.9 397 . 4c0 2-2 . 3 3 . 6-5 . 2 3 . 6-3 . 3 . 3-5 . 6-1 . 3-5 . 6-3 . 6 0-2 2 . 3-3 . 6 5 . 2-3 . 6 3- . 3 5 . 6 1 . 3 5 . 6 3 . 6zm-31 . 1-4 . 5c- . 7 2 1 . 3 4 . 3 4 . 3 4 . 9 2 . 6 1 5 . 6 0 6 . 2-2s-1 . 3-4 . 3-4 . 3-5 . 2c-2 . 6- . 7-5 . 5 . 3-6 . 2 2 . 3zm44 . 2-1 . 7c-2 . 9 . 7-4 . 9 2 . 6-4 . 6 4 . 9 . 3 2 2 . 9 3 . 3 5 . 9 2 . 6 2 . 9- . 7 4 . 9-2 . 6 4 . 6-4 . 6- . 3-1 . 9-3-3 . 2-5 . 9-2 . 9zM244 . 8 8C106 . 1 8 0 113 . 3 0 252c0 110 . 9 69 . 8 20
