A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from http://open-source-parsers.github.io/jsoncpp-docs/doxygen/class_json_1_1_value.html below:

Represents a JSON value. More...

#include <json/value.h>

  Value (ValueType type=nullValue)   Create a default Value of the given type. More...
    Value (Int value)     Value (UInt value)     Value (Int64 value)     Value (UInt64 value)     Value (double value)     Value (const char *value)   Copy til first 0. (NULL causes to seg-fault.) More...
    Value (const char *begin, const char *end)   Copy all, incl zeroes. More...
    Value (const StaticString &value)   Constructs a value from a static string. More...
    Value (const String &value)     Value (bool value)     Value (std::nullptr_t ptr)=delete     Value (const Value &other)     Value (Value &&other) noexcept     ~Value ()   Valueoperator= (const Value &other)   Valueoperator= (Value &&other) noexcept   void  swap (Value &other)   Swap everything. More...
  void  swapPayload (Value &other)   Swap values but leave comments and source offsets in place. More...
  void  copy (const Value &other)   copy everything. More...
  void  copyPayload (const Value &other)   copy values but leave comments and source offsets in place. More...
  ValueType  type () const   bool  operator< (const Value &other) const   Compare payload only, not comments etc. More...
  bool  operator<= (const Value &other) const   bool  operator>= (const Value &other) const   bool  operator> (const Value &other) const   bool  operator== (const Value &other) const   bool  operator!= (const Value &other) const   int  compare (const Value &other) const   const char *  asCString () const   Embedded zeroes could cause you trouble! More...
  String  asString () const   Embedded zeroes are possible. More...
  bool  getString (char const **begin, char const **end) const   Get raw char* of string-value. More...
  Int  asInt () const   UInt  asUInt () const   Int64  asInt64 () const   UInt64  asUInt64 () const   LargestInt  asLargestInt () const   LargestUInt  asLargestUInt () const   float  asFloat () const   double  asDouble () const   bool  asBool () const   bool  isNull () const   bool  isBool () const   bool  isInt () const   bool  isInt64 () const   bool  isUInt () const   bool  isUInt64 () const   bool  isIntegral () const   bool  isDouble () const   bool  isNumeric () const   bool  isString () const   bool  isArray () const   bool  isObject () const   template<typename T > T  as () const =delete   The as<T> and is<T> member function templates and specializations. More...
  template<typename T > bool  is () const =delete   bool  isConvertibleTo (ValueType other) const   ArrayIndex  size () const   Number of values in array or object. More...
  bool  empty () const   Return true if empty array, empty object, or null; otherwise, false. More...
    operator bool () const   Return !isNull() More...
  void  clear ()   Remove all object members and array elements. More...
  void  resize (ArrayIndex newSize)   Resize the array to newSize elements. More...
  Valueoperator[] (ArrayIndex index)   Access an array element (zero based index). More...
  Valueoperator[] (int index)   const Valueoperator[] (ArrayIndex index) const   Access an array element (zero based index). More...
  const Valueoperator[] (int index) const   Value  get (ArrayIndex index, const Value &defaultValue) const   If the array contains at least index+1 elements, returns the element value, otherwise returns defaultValue. More...
  bool  isValidIndex (ArrayIndex index) const   Return true if index < size(). More...
  Valueappend (const Value &value)   Append value to array at the end. More...
  Valueappend (Value &&value)   bool  insert (ArrayIndex index, const Value &newValue)   Insert value in array at specific index. More...
  bool  insert (ArrayIndex index, Value &&newValue)   Valueoperator[] (const char *key)   Access an object value by name, create a null member if it does not exist. More...
  const Valueoperator[] (const char *key) const   Access an object value by name, returns null if there is no member with that name. More...
  Valueoperator[] (const String &key)   Access an object value by name, create a null member if it does not exist. More...
  const Valueoperator[] (const String &key) const   Access an object value by name, returns null if there is no member with that name. More...
  Valueoperator[] (const StaticString &key)   Access an object value by name, create a null member if it does not exist. More...
  Value  get (const char *key, const Value &defaultValue) const   Return the member named key if it exist, defaultValue otherwise. More...
  Value  get (const char *begin, const char *end, const Value &defaultValue) const   Return the member named key if it exist, defaultValue otherwise. More...
  Value  get (const String &key, const Value &defaultValue) const   Return the member named key if it exist, defaultValue otherwise. More...
  Value const *  find (char const *begin, char const *end) const   Most general and efficient version of isMember()const, get()const, and operator[]const. More...
  Valuedemand (char const *begin, char const *end)   Most general and efficient version of object-mutators. More...
  void  removeMember (const char *key)   Remove and return the named member. More...
  void  removeMember (const String &key)   Same as removeMember(const char*) More...
  bool  removeMember (const char *key, Value *removed)   Same as removeMember(const char* begin, const char* end, Value* removed), but 'key' is null-terminated. More...
  bool  removeMember (String const &key, Value *removed)   Remove the named map member. More...
  bool  removeMember (const char *begin, const char *end, Value *removed)   Same as removeMember(String const& key, Value* removed) More...
  bool  removeIndex (ArrayIndex index, Value *removed)   Remove the indexed array element. More...
  bool  isMember (const char *key) const   Return true if the object has a member named key. More...
  bool  isMember (const String &key) const   Return true if the object has a member named key. More...
  bool  isMember (const char *begin, const char *end) const   Same as isMember(String const& key)const. More...
  Members  getMemberNames () const   Return a list of the member names. More...
    __declspec (deprecated("Use setComment(String const&) instead.")) void setComment(const char *comment   void  setComment (const char *comment, size_t len, CommentPlacement placement)   Comments must be //... or /* ... *‍/. More...
  void  setComment (String comment, CommentPlacement placement)   Comments must be //... or /* ... *‍/. More...
  bool  hasComment (CommentPlacement placement) const   String  getComment (CommentPlacement placement) const   Include delimiters and embedded newlines. More...
  String  toStyledString () const   const_iterator  begin () const   const_iterator  end () const   iterator  begin ()   iterator  end ()   void  setOffsetStart (ptrdiff_t start)   void  setOffsetLimit (ptrdiff_t limit)   ptrdiff_t  getOffsetStart () const   ptrdiff_t  getOffsetLimit () const   template<> bool  as () const   template<> bool  is () const   template<> Int  as () const   template<> bool  is () const   template<> UInt  as () const   template<> bool  is () const   template<> Int64  as () const   template<> bool  is () const   template<> UInt64  as () const   template<> bool  is () const   template<> double  as () const   template<> bool  is () const   template<> String  as () const   template<> bool  is () const   template<> float  as () const   These as specializations are type conversions, and do not have a corresponding is. More...
  template<> const char *  as () const  

Represents a JSON value.

This class is a discriminated union wrapper that can represents a:

The type of the held value is represented by a ValueType and can be obtained using type().

Values of an objectValue or arrayValue can be accessed using operator[]() methods. Non-const methods will automatically create the a nullValue element if it does not exist. The sequence of an arrayValue will be automatically resized and initialized with nullValue. resize() can be used to enlarge or truncate an arrayValue.

The get() methods can be used to obtain default value in the case the required element does not exist.

It is possible to iterate over the list of member keys of an object using the getMemberNames() method.

Note
Value string-length fit in size_t, but keys must be < 2^30. (The reason is an implementation detail.) A #CharReader will raise an exception if a bound is exceeded to avoid security holes in your app, but the Value API does not check bounds. That is the responsibility of the caller.
◆ ArrayIndex ◆ const_iterator ◆ Int ◆ Int64 ◆ iterator ◆ LargestInt ◆ LargestUInt ◆ Members ◆ UInt ◆ UInt64 ◆ value_type ◆ Value() [1/14]

Create a default Value of the given type.

This is a very useful constructor. To create an empty array, pass arrayValue. To create an empty object, pass objectValue. Another Value can then be set to this one by assignment. This is useful since clear() and resize() will not alter types.

Examples:

Represents a JSON value.

Definition: value.h:193

@ arrayValue

array value (ordered list)

Definition: value.h:114

@ objectValue

object value (collection of name/value pairs).

Definition: value.h:115

Default constructor initialization must be equivalent to: memset( this, 0, sizeof(Value) ) This optimization is used in ValueInternalMap fast allocator.

◆ Value() [2/14] Json::Value::Value ( Int  value ) ◆ Value() [3/14] Json::Value::Value ( UInt  value ) ◆ Value() [4/14] Json::Value::Value ( Int64  value ) ◆ Value() [5/14] Json::Value::Value ( UInt64  value ) ◆ Value() [6/14] Json::Value::Value ( double  value ) ◆ Value() [7/14] Json::Value::Value ( const char *  value )

Copy til first 0. (NULL causes to seg-fault.)

◆ Value() [8/14] Json::Value::Value ( const char *  begin, const char *  end  )

Copy all, incl zeroes.

◆ Value() [9/14]

Constructs a value from a static string.

Like other value string constructor but do not duplicate the string for internal storage. The given string must remain alive after the call to this constructor.

Note
This works only for null-terminated strings. (We cannot change the size of this class, so we have nowhere to store the length, which might be computed later for various operations.)

Example of usage:

static StaticString foo("some text");

◆ Value() [10/14] Json::Value::Value ( const Stringvalue ) ◆ Value() [11/14] Json::Value::Value ( bool  value ) ◆ Value() [12/14] Json::Value::Value ( std::nullptr_t  ptr ) delete ◆ Value() [13/14] Json::Value::Value ( const Valueother ) ◆ Value() [14/14] Json::Value::Value ( Value &&  other ) noexcept ◆ ~Value() ◆ __declspec() Json::Value::__declspec ( deprecated("Use setComment(String const&) instead.")  ) const ◆ append() [1/2] Value & Json::Value::append ( const Valuevalue )

Append value to array at the end.

Equivalent to jsonvalue[jsonvalue.size()] = value;

◆ append() [2/2] ◆ as() [1/10]

template<>

bool Json::Value::as ( ) const inline ◆ as() [2/10]

template<>

Int Json::Value::as ( ) const inline ◆ as() [3/10]

template<>

UInt Json::Value::as ( ) const inline ◆ as() [4/10]

template<>

Int64 Json::Value::as ( ) const inline ◆ as() [5/10]

template<>

UInt64 Json::Value::as ( ) const inline ◆ as() [6/10]

template<>

double Json::Value::as ( ) const inline ◆ as() [7/10]

template<>

String Json::Value::as ( ) const inline ◆ as() [8/10]

template<>

float Json::Value::as ( ) const inline

These as specializations are type conversions, and do not have a corresponding is.

◆ as() [9/10]

template<>

const char* Json::Value::as ( ) const inline ◆ as() [10/10]

template<typename T >

T Json::Value::as ( ) const delete

The as<T> and is<T> member function templates and specializations.

◆ asBool() bool Json::Value::asBool ( ) const ◆ asCString() const char * Json::Value::asCString ( ) const

Embedded zeroes could cause you trouble!

◆ asDouble() double Json::Value::asDouble ( ) const ◆ asFloat() float Json::Value::asFloat ( ) const ◆ asInt() ◆ asInt64() ◆ asLargestInt() ◆ asLargestUInt() ◆ asString() String Json::Value::asString ( ) const

Embedded zeroes are possible.

◆ asUInt() ◆ asUInt64() ◆ begin() [1/2] ◆ begin() [2/2] ◆ clear() void Json::Value::clear ( )

Remove all object members and array elements.

Precondition
type() is arrayValue, objectValue, or nullValue
Postcondition
type() is unchanged
◆ compare() int Json::Value::compare ( const Valueother ) const ◆ copy() void Json::Value::copy ( const Valueother )

copy everything.

◆ copyPayload() void Json::Value::copyPayload ( const Valueother )

copy values but leave comments and source offsets in place.

◆ demand() Value * Json::Value::demand ( char const *  begin, char const *  end  )

Most general and efficient version of object-mutators.

Note
As stated elsewhere, behavior is undefined if (end-begin) >= 2^30
Returns
non-zero, but JSON_ASSERT if this is neither object nor nullValue.
◆ empty() bool Json::Value::empty ( ) const

Return true if empty array, empty object, or null; otherwise, false.

◆ end() [1/2] ◆ end() [2/2] ◆ find() Value const * Json::Value::find ( char const *  begin, char const *  end  ) const

Most general and efficient version of isMember()const, get()const, and operator[]const.

Note
As stated elsewhere, behavior is undefined if (end-begin) >= 2^30
◆ get() [1/4]

If the array contains at least index+1 elements, returns the element value, otherwise returns defaultValue.

◆ get() [2/4] Value Json::Value::get ( const char *  begin, const char *  end, const ValuedefaultValue  ) const

Return the member named key if it exist, defaultValue otherwise.

Note
deep copy
key may contain embedded nulls.
◆ get() [3/4] Value Json::Value::get ( const char *  key, const ValuedefaultValue  ) const

Return the member named key if it exist, defaultValue otherwise.

Note
deep copy
◆ get() [4/4]

Return the member named key if it exist, defaultValue otherwise.

Note
deep copy
Parameters
key may contain embedded nulls.
◆ getComment()

Include delimiters and embedded newlines.

◆ getMemberNames()

Return a list of the member names.

If null, return an empty list.

Precondition
type() is objectValue or nullValue
Postcondition
if type() was nullValue, it remains nullValue
◆ getOffsetLimit() ptrdiff_t Json::Value::getOffsetLimit ( ) const ◆ getOffsetStart() ptrdiff_t Json::Value::getOffsetStart ( ) const ◆ getString() bool Json::Value::getString ( char const **  begin, char const **  end  ) const

Get raw char* of string-value.

Returns
false if !string. (Seg-fault if str or end are NULL.)
◆ hasComment() ◆ insert() [1/2]

Insert value in array at specific index.

◆ insert() [2/2] ◆ is() [1/8]

template<>

bool Json::Value::is ( ) const inline ◆ is() [2/8]

template<>

bool Json::Value::is ( ) const inline ◆ is() [3/8]

template<>

bool Json::Value::is ( ) const inline ◆ is() [4/8]

template<>

bool Json::Value::is ( ) const inline ◆ is() [5/8]

template<>

bool Json::Value::is ( ) const inline ◆ is() [6/8]

template<>

bool Json::Value::is ( ) const inline ◆ is() [7/8]

template<>

bool Json::Value::is ( ) const inline ◆ is() [8/8]

template<typename T >

bool Json::Value::is ( ) const delete ◆ isArray() bool Json::Value::isArray ( ) const ◆ isBool() bool Json::Value::isBool ( ) const ◆ isConvertibleTo() bool Json::Value::isConvertibleTo ( ValueType  other ) const ◆ isDouble() bool Json::Value::isDouble ( ) const ◆ isInt() bool Json::Value::isInt ( ) const ◆ isInt64() bool Json::Value::isInt64 ( ) const ◆ isIntegral() bool Json::Value::isIntegral ( ) const ◆ isMember() [1/3] ◆ isMember() [2/3] bool Json::Value::isMember ( const char *  key ) const

Return true if the object has a member named key.

Note
'key' must be null-terminated.
◆ isMember() [3/3] bool Json::Value::isMember ( const Stringkey ) const

Return true if the object has a member named key.

Parameters
key may contain embedded nulls.
◆ isNull() bool Json::Value::isNull ( ) const ◆ isNumeric() bool Json::Value::isNumeric ( ) const ◆ isObject() bool Json::Value::isObject ( ) const ◆ isString() bool Json::Value::isString ( ) const ◆ isUInt() bool Json::Value::isUInt ( ) const ◆ isUInt64() bool Json::Value::isUInt64 ( ) const ◆ isValidIndex() bool Json::Value::isValidIndex ( ArrayIndex  index ) const

Return true if index < size().

◆ nullSingleton() Value const & Json::Value::nullSingleton ( ) static ◆ operator bool() Json::Value::operator bool ( ) const explicit

Return !isNull()

◆ operator!=() bool Json::Value::operator!= ( const Valueother ) const ◆ operator<() bool Json::Value::operator< ( const Valueother ) const

Compare payload only, not comments etc.

◆ operator<=() bool Json::Value::operator<= ( const Valueother ) const ◆ operator=() [1/2] Value & Json::Value::operator= ( const Valueother )
Note
Overwrite existing comments. To preserve comments, use swapPayload().
◆ operator=() [2/2] ◆ operator==() bool Json::Value::operator== ( const Valueother ) const ◆ operator>() bool Json::Value::operator> ( const Valueother ) const ◆ operator>=() bool Json::Value::operator>= ( const Valueother ) const ◆ operator[]() [1/9]

Access an array element (zero based index).

If the array contains less than index element, then null value are inserted in the array so that its size is index+1. (You may need to say 'value[0u]' to get your compiler to distinguish this from the operator[] which takes a string.)

◆ operator[]() [2/9]

Access an array element (zero based index).

(You may need to say 'value[0u]' to get your compiler to distinguish this from the operator[] which takes a string.)

◆ operator[]() [3/9] Value & Json::Value::operator[] ( const char *  key )

Access an object value by name, create a null member if it does not exist.

Note
Because of our implementation, keys are limited to 2^30 -1 chars. Exceeding that will cause an exception.
◆ operator[]() [4/9] const Value & Json::Value::operator[] ( const char *  key ) const

Access an object value by name, returns null if there is no member with that name.

◆ operator[]() [5/9]

Access an object value by name, create a null member if it does not exist.

If the object has no entry for that name, then the member name used to store the new entry is not duplicated. Example of use:

static const StaticString code("code");

object[code] = 1234;

◆ operator[]() [6/9]

Access an object value by name, create a null member if it does not exist.

Parameters
key may contain embedded nulls.
◆ operator[]() [7/9] Value const & Json::Value::operator[] ( const Stringkey ) const

Access an object value by name, returns null if there is no member with that name.

Parameters
key may contain embedded nulls.
◆ operator[]() [8/9] Value & Json::Value::operator[] ( int  index ) ◆ operator[]() [9/9] const Value & Json::Value::operator[] ( int  index ) const ◆ removeIndex()

Remove the indexed array element.

O(n) expensive operations. Update 'removed' iff removed.

Returns
true if removed (no exceptions)
◆ removeMember() [1/5] ◆ removeMember() [2/5] void Json::Value::removeMember ( const char *  key )

Remove and return the named member.

Do nothing if it did not exist.

Precondition
type() is objectValue or nullValue
Postcondition
type() is unchanged
◆ removeMember() [3/5] ◆ removeMember() [4/5] void Json::Value::removeMember ( const Stringkey ) ◆ removeMember() [5/5] bool Json::Value::removeMember ( String const &  key, Valueremoved  )

Remove the named map member.

Update 'removed' iff removed.

Parameters
key may contain embedded nulls.
Returns
true iff removed (no exceptions)
◆ resize()

Resize the array to newSize elements.

New elements are initialized to null. May only be called on nullValue or arrayValue.

Precondition
type() is arrayValue or nullValue
Postcondition
type() is arrayValue
◆ setComment() [1/2] void Json::Value::setComment ( const char *  comment, size_t  len, CommentPlacement  placement  ) inline

Comments must be //... or /* ... *‍/.

◆ setComment() [2/2]

Comments must be //... or /* ... *‍/.

◆ setOffsetLimit() void Json::Value::setOffsetLimit ( ptrdiff_t  limit ) ◆ setOffsetStart() void Json::Value::setOffsetStart ( ptrdiff_t  start ) ◆ size()

Number of values in array or object.

◆ swap() void Json::Value::swap ( Valueother )

Swap everything.

◆ swapPayload() void Json::Value::swapPayload ( Valueother )

Swap values but leave comments and source offsets in place.

◆ toStyledString() String Json::Value::toStyledString ( ) const ◆ type() ◆ ValueIteratorBase ◆ allocated_ unsigned int Json::Value::allocated_ ◆ defaultRealPrecision constexpr UInt Json::Value::defaultRealPrecision = 17 staticconstexpr

Default precision for real value for string representation.

◆ maxInt constexpr Int Json::Value::maxInt = Int(UInt(-1) / 2) staticconstexpr

Maximum signed int value that can be stored in a Json::Value.

◆ maxInt64

Maximum signed 64 bits int value that can be stored in a Json::Value.

◆ maxLargestInt

Maximum signed integer value that can be stored in a Json::Value.

◆ maxLargestUInt

Maximum unsigned integer value that can be stored in a Json::Value.

◆ maxUInt constexpr UInt Json::Value::maxUInt = UInt(-1) staticconstexpr

Maximum unsigned int value that can be stored in a Json::Value.

◆ maxUInt64

Maximum unsigned 64 bits int value that can be stored in a Json::Value.

◆ maxUInt64AsDouble constexpr double Json::Value::maxUInt64AsDouble = 18446744073709551615.0 staticconstexpr ◆ minInt constexpr Int Json::Value::minInt = Int(~(UInt(-1) / 2)) staticconstexpr

Minimum signed int value that can be stored in a Json::Value.

◆ minInt64

Minimum signed 64 bits int value that can be stored in a Json::Value.

◆ minLargestInt Initial value:

=

Json::LargestInt LargestInt

Definition: value.h:206

Json::LargestUInt LargestUInt

Definition: value.h:207

Minimum signed integer value that can be stored in a Json::Value.

◆ null ◆ nullRef ◆ placement Initial value:

{

void setComment(const char *comment, size_t len, CommentPlacement placement)

Comments must be //... or /* ... *‍/.

Definition: value.h:570

CommentPlacement placement

Definition: value.h:566

std::basic_string< char, std::char_traits< char >, Allocator< char > > String

Definition: config.h:132

◆ value_type_ unsigned int Json::Value::value_type_

The documentation for this class was generated from the following files:


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4