web::json::array Class Reference

A JSON array represented as a C++ class. More...

#include <json.h>

Public Types
typedef storage_type::iterator	iterator
typedef storage_type::const_iterator	const_iterator
typedef storage_type::reverse_iterator	reverse_iterator
typedef storage_type::const_reverse_iterator	const_reverse_iterator
typedef storage_type::size_type	size_type

Public Member Functions
iterator	begin ()
	Gets the beginning iterator element of the array More...
const_iterator	begin () const
	Gets the beginning const iterator element of the array. More...
iterator	end ()
	Gets the end iterator element of the array More...
const_iterator	end () const
	Gets the end const iterator element of the array. More...
reverse_iterator	rbegin ()
	Gets the beginning reverse iterator element of the array More...
const_reverse_iterator	rbegin () const
	Gets the beginning const reverse iterator element of the array More...
reverse_iterator	rend ()
	Gets the end reverse iterator element of the array More...
const_reverse_iterator	rend () const
	Gets the end const reverse iterator element of the array More...
const_iterator	cbegin () const
	Gets the beginning const iterator element of the array. More...
const_iterator	cend () const
	Gets the end const iterator element of the array. More...
const_reverse_iterator	crbegin () const
	Gets the beginning const reverse iterator element of the array. More...
const_reverse_iterator	crend () const
	Gets the end const reverse iterator element of the array. More...
iterator	erase (iterator position)
	Deletes an element of the JSON array. More...
void	erase (size_type index)
	Deletes the element at an index of the JSON array. More...
json::value &	at (size_type index)
	Accesses an element of a JSON array. Throws when index out of bounds. More...
const json::value &	at (size_type index) const
	Accesses an element of a JSON array. Throws when index out of bounds. More...
json::value &	operator[] (size_type index)
	Accesses an element of a JSON array. More...
size_type	size () const
	Gets the number of elements of the array. More...

Friends
class	details::_Array
template<typename CharType >
class	json::details::JSON_Parser

Detailed Description

A JSON array represented as a C++ class.

Member Function Documentation

json::value& web::json::array::at ( size_type  index )

inline

Accesses an element of a JSON array. Throws when index out of bounds.

Parameters

index

The index of an element in the JSON array.

Returns

A reference to the value kept in the field.

const json::value& web::json::array::at ( size_type  index ) const

inline

Accesses an element of a JSON array. Throws when index out of bounds.

Parameters

index

The index of an element in the JSON array.

Returns

A reference to the value kept in the field.

iterator web::json::array::begin ( )

inline

Gets the beginning iterator element of the array

Returns

An iterator to the beginning of the JSON array.

const_iterator web::json::array::begin ( ) const

inline

Gets the beginning const iterator element of the array.

Returns

A const_iterator to the beginning of the JSON array.

const_iterator web::json::array::cbegin ( ) const

inline

Gets the beginning const iterator element of the array.

Returns

A const_iterator to the beginning of the JSON array.

const_iterator web::json::array::cend ( ) const

inline

Gets the end const iterator element of the array.

Returns

A const_iterator to the end of the JSON array.

const_reverse_iterator web::json::array::crbegin ( ) const

inline

Gets the beginning const reverse iterator element of the array.

Returns

A const_reverse_iterator to the beginning of the JSON array.

const_reverse_iterator web::json::array::crend ( ) const

inline

Gets the end const reverse iterator element of the array.

Returns

A const_reverse_iterator to the end of the JSON array.

iterator web::json::array::end ( )

inline

Gets the end iterator element of the array

Returns

An iterator to the end of the JSON array.

const_iterator web::json::array::end ( ) const

inline

Gets the end const iterator element of the array.

Returns

A const_iterator to the end of the JSON array.

iterator web::json::array::erase ( iterator  position )

inline

Deletes an element of the JSON array.

Parameters

position

A const_iterator to the element to delete.

Returns

Iterator to the new location of the element following the erased element.

GCC doesn't support erase with const_iterator on vector yet. In the future this should be changed.

void web::json::array::erase ( size_type  index )

inline

Deletes the element at an index of the JSON array.

Parameters

index

The index of the element to delete.

json::value& web::json::array::operator[] ( size_type  index )

inline

Accesses an element of a JSON array.

Parameters

index

The index of an element in the JSON array.

Returns

A reference to the value kept in the field.

reverse_iterator web::json::array::rbegin ( )

inline

Gets the beginning reverse iterator element of the array

Returns

An reverse_iterator to the beginning of the JSON array.

const_reverse_iterator web::json::array::rbegin ( ) const

inline

Gets the beginning const reverse iterator element of the array

Returns

An const_reverse_iterator to the beginning of the JSON array.

reverse_iterator web::json::array::rend ( )

inline

Gets the end reverse iterator element of the array

Returns

An reverse_iterator to the end of the JSON array.

const_reverse_iterator web::json::array::rend ( ) const

inline

Gets the end const reverse iterator element of the array

Returns

An const_reverse_iterator to the end of the JSON array.

size_type web::json::array::size ( ) const

inline

Gets the number of elements of the array.

Returns

The number of elements.

---

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

• include/cpprest/json.h