fc::mutable_variant_object Class Reference

An order-preserving dictionary of variants. More...

#include <variant_object.hpp>

Public Types
typedef variant_object::entry	entry
	a key/value pair
typedef std::vector< entry >::iterator	iterator
typedef std::vector< entry >::const_iterator	const_iterator

Public Member Functions
variant &	operator[] (const string &key)
variant &	operator[] (const char *key)
template<typename T , typename = std::enable_if_t<!std::is_base_of<mutable_variant_object, std::decay_t<T>>::value>>
	mutable_variant_object (T &&v)
	mutable_variant_object ()
	mutable_variant_object (string key, variant val)
template<typename T >
	mutable_variant_object (string key, T &&val)
	mutable_variant_object (mutable_variant_object &&)
	mutable_variant_object (const mutable_variant_object &)
	mutable_variant_object (const variant_object &)
mutable_variant_object &	operator= (mutable_variant_object &&)
mutable_variant_object &	operator= (const mutable_variant_object &)
mutable_variant_object &	operator= (const variant_object &)
Immutable Interface
Calling these methods will not result in copies of the underlying type.
iterator	begin () const
iterator	end () const
iterator	find (const string &key) const
iterator	find (const char *key) const
const variant &	operator[] (const string &key) const
const variant &	operator[] (const char *key) const
size_t	size () const
mutable Interface
Calling these methods will result in a copy of the underlying type being created if there is more than one reference to this object.
void	reserve (size_t s)
iterator	begin ()
iterator	end ()
void	erase (const string &key)
iterator	find (const string &key)
iterator	find (const char *key)
mutable_variant_object &	set (string key, variant var) &
mutable_variant_object	set (string key, variant var) &&
mutable_variant_object &	operator() (string key, variant var) &
mutable_variant_object	operator() (string key, variant var) &&
template<typename T >
mutable_variant_object &	operator() (string key, T &&var) &
template<typename T >
mutable_variant_object	operator() (string key, T &&var) &&
mutable_variant_object &	operator() (const variant_object &vo) &
mutable_variant_object	operator() (const variant_object &vo) &&
mutable_variant_object &	operator() (const mutable_variant_object &mvo) &
mutable_variant_object	operator() (const mutable_variant_object &mvo) &&

Friends
class	variant_object

Detailed Description

Keys are kept in the order they are inserted. This dictionary implements copy-on-write

Note

This class is not optimized for random-access on large sets of key-value pairs.

Definition at line 117 of file variant_object.hpp.

Member Typedef Documentation

const_iterator

std::vector<entry>::const_iterator fc::mutable_variant_object::const_iterator

Definition at line 124 of file variant_object.hpp.

entry

variant_object::entry fc::mutable_variant_object::entry

Definition at line 121 of file variant_object.hpp.

iterator

std::vector<entry>::iterator fc::mutable_variant_object::iterator

Definition at line 123 of file variant_object.hpp.

Constructor & Destructor Documentation

mutable_variant_object() [1/7]

template<typename T , typename = std::enable_if_t<!std::is_base_of<mutable_variant_object, std::decay_t<T>>::value>>

fc::mutable_variant_object::mutable_variant_object ( T && v )

inlineexplicit

Definition at line 212 of file variant_object.hpp.

      :_key_value( new std::vector<entry>() )
      {
          *this = variant(fc::forward<T>(v)).get_object();
      }

Here is the call graph for this function:

mutable_variant_object() [2/7]

fc::mutable_variant_object::mutable_variant_object

(

)

Definition at line 273 of file variant_object.cpp.

      :_key_value(new std::vector<entry>)
   {
   }

mutable_variant_object() [3/7]

fc::mutable_variant_object::mutable_variant_object	(	string	key,
		variant	val )

initializes the first key/value pair in the object

Definition at line 278 of file variant_object.cpp.

      : _key_value(new std::vector<entry>())
   {
       _key_value->push_back(entry(fc::move(key), fc::move(val)));
   }

mutable_variant_object() [4/7]

template<typename T >

fc::mutable_variant_object::mutable_variant_object ( string key, T && val )

inline

Definition at line 223 of file variant_object.hpp.

      :_key_value( new std::vector<entry>() )
      {
         set( std::move(key), variant(forward<T>(val)) );
      }

mutable_variant_object() [5/7]

fc::mutable_variant_object::mutable_variant_object

(

mutable_variant_object &&

obj

)

Definition at line 294 of file variant_object.cpp.

      : _key_value(fc::move(obj._key_value))
   {
   }

mutable_variant_object() [6/7]

fc::mutable_variant_object::mutable_variant_object

(

const mutable_variant_object &

obj

)

Definition at line 289 of file variant_object.cpp.

      : _key_value( new std::vector<entry>(*obj._key_value) )
   {
   }

mutable_variant_object() [7/7]

fc::mutable_variant_object::mutable_variant_object

(

const variant_object &

obj

)

Definition at line 284 of file variant_object.cpp.

      : _key_value( new std::vector<entry>(*obj._key_value) )
   {
   }

Member Function Documentation

begin() [1/2]

mutable_variant_object::iterator fc::mutable_variant_object::begin

(

)

Definition at line 190 of file variant_object.cpp.

   {
      return _key_value->begin();
   }

begin() [2/2]

mutable_variant_object::iterator fc::mutable_variant_object::begin

(

)

const

Definition at line 200 of file variant_object.cpp.

   {
      return _key_value->begin();
   }

Here is the caller graph for this function:

end() [1/2]

mutable_variant_object::iterator fc::mutable_variant_object::end

(

)

Definition at line 195 of file variant_object.cpp.

   {
      return _key_value->end();
   }

end() [2/2]

mutable_variant_object::iterator fc::mutable_variant_object::end

(

)

const

Definition at line 205 of file variant_object.cpp.

   {
      return _key_value->end();
   }

Here is the caller graph for this function:

erase()

void fc::mutable_variant_object::erase

(

const string &

key

)

Definition at line 328 of file variant_object.cpp.

   {
      for( auto itr = begin(); itr != end(); ++itr )
      {
         if( itr->key() == key )
         {
            _key_value->erase(itr);
            return;
         }
      }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

find() [1/4]

mutable_variant_object::iterator fc::mutable_variant_object::find

(

const char *

key

)

Definition at line 232 of file variant_object.cpp.

   {
      for( auto itr = begin(); itr != end(); ++itr )
      {
         if( itr->key() == key )
         {
            return itr;
         }
      }
      return end();
   }

Here is the call graph for this function:

find() [2/4]

mutable_variant_object::iterator fc::mutable_variant_object::find

(

const char *

key

)

const

Definition at line 215 of file variant_object.cpp.

   {
      for( auto itr = begin(); itr != end(); ++itr )
      {
         if( itr->key() == key )
         {
            return itr;
         }
      }
      return end();
   }

Here is the call graph for this function:

find() [3/4]

mutable_variant_object::iterator fc::mutable_variant_object::find

(

const string &

key

)

Returns

end() if key is not found

Definition at line 227 of file variant_object.cpp.

   {
      return find( key.c_str() );
   }

Here is the call graph for this function:

find() [4/4]

mutable_variant_object::iterator fc::mutable_variant_object::find

(

const string &

key

)

const

Definition at line 210 of file variant_object.cpp.

   {
      return find( key.c_str() );
   }

Here is the call graph for this function:

Here is the caller graph for this function:

operator()() [1/8]

mutable_variant_object & fc::mutable_variant_object::operator()

(

const mutable_variant_object &

mvo

)

&

Copy another mutable_variant_object into this mutable_variant_object.

Definition at line 398 of file variant_object.cpp.

   {
      if( &mvo == this )     // mvo(mvo) is no-op
         return *this;
      for( const mutable_variant_object::entry& e : mvo )
         set( e.key(), e.value() );
      return *this;
   }

operator()() [2/8]

mutable_variant_object fc::mutable_variant_object::operator()

(

const mutable_variant_object &

mvo

)

&&

Definition at line 407 of file variant_object.cpp.

   {
      for( const mutable_variant_object::entry& e : mvo )
         set( e.key(), e.value() );
      return std::move(*this);
   }

operator()() [3/8]

mutable_variant_object & fc::mutable_variant_object::operator()

(

const variant_object &

vo

)

&

Copy a variant_object into this mutable_variant_object.

Definition at line 384 of file variant_object.cpp.

   {
      for( const variant_object::entry& e : vo )
         set( e.key(), e.value() );
      return *this;
   }

operator()() [4/8]

mutable_variant_object fc::mutable_variant_object::operator()

(

const variant_object &

vo

)

&&

Definition at line 391 of file variant_object.cpp.

   {
      for( const variant_object::entry& e : vo )
         set( e.key(), e.value() );
      return std::move(*this);
   }

operator()() [5/8]

template<typename T >

mutable_variant_object & fc::mutable_variant_object::operator() ( string key, T && var ) &

inline

Definition at line 185 of file variant_object.hpp.

      {
         set(std::move(key), variant( fc::forward<T>(var) ) );
         return *this;
      }

operator()() [6/8]

template<typename T >

mutable_variant_object fc::mutable_variant_object::operator() ( string key, T && var ) &&

inline

Definition at line 191 of file variant_object.hpp.

      {
         set(std::move(key), variant( fc::forward<T>(var) ) );
         return std::move(*this);
      }

operator()() [7/8]

mutable_variant_object & fc::mutable_variant_object::operator()	(	string	key,
		variant	var ) &

Appends key and var without checking for duplicates, designed to simplify construction of dictionaries using (key,val)(key2,val2) syntax Convenience method to simplify the manual construction of variant_objects

Instead of: mutable_variant_object("c",c).set("a",a).set("b",b);

You can use: mutable_variant_object( "c", c )( "b", b)( "c",c )

Returns

*this;

Appends key and var without checking for duplicates, designed to simplify construction of dictionaries using (key,val)(key2,val2) syntax

Definition at line 372 of file variant_object.cpp.

   {
      _key_value->push_back( entry( fc::move(key), fc::move(var) ) );
      return *this;
   }

operator()() [8/8]

mutable_variant_object fc::mutable_variant_object::operator()	(	string	key,
		variant	var ) &&

Definition at line 378 of file variant_object.cpp.

   {
      _key_value->push_back( entry( fc::move(key), fc::move(var) ) );
      return std::move(*this);
   }

operator=() [1/3]

mutable_variant_object & fc::mutable_variant_object::operator=

(

const mutable_variant_object &

obj

)

Definition at line 314 of file variant_object.cpp.

   {
      if (this != &obj)
      {
         *_key_value = *obj._key_value;
      }
      return *this;
   }

operator=() [2/3]

mutable_variant_object & fc::mutable_variant_object::operator=

(

const variant_object &

obj

)

Definition at line 299 of file variant_object.cpp.

   {
      *_key_value = *obj._key_value;
      return *this;
   }

operator=() [3/3]

mutable_variant_object & fc::mutable_variant_object::operator=

(

mutable_variant_object &&

obj

)

Definition at line 305 of file variant_object.cpp.

   {
      if (this != &obj)
      {
         _key_value = fc::move(obj._key_value);
      }
      return *this;
   }

operator[]() [1/4]

variant & fc::mutable_variant_object::operator[]

(

const char *

key

)

Definition at line 260 of file variant_object.cpp.

   {
      auto itr = find( key );
      if( itr != end() ) return itr->value();
      _key_value->emplace_back(entry(key, variant()));
      return _key_value->back().value();
   }

Here is the call graph for this function:

operator[]() [2/4]

const variant & fc::mutable_variant_object::operator[]

(

const char *

key

)

const

Definition at line 249 of file variant_object.cpp.

   {
      auto itr = find( key );
      if( itr != end() ) return itr->value();
      FC_THROW_EXCEPTION( key_not_found_exception, "Key ${key}", ("key",key) );
   }

Here is the call graph for this function:

operator[]() [3/4]

variant & fc::mutable_variant_object::operator[]

(

const string &

key

)

Definition at line 255 of file variant_object.cpp.

   {
      return (*this)[key.c_str()];
   }

operator[]() [4/4]

const variant & fc::mutable_variant_object::operator[]

(

const string &

key

)

const

Definition at line 244 of file variant_object.cpp.

   {
      return (*this)[key.c_str()];
   }

reserve()

void fc::mutable_variant_object::reserve

(

size_t

s

)

Definition at line 323 of file variant_object.cpp.

   {
      _key_value->reserve(s);
   }

Here is the caller graph for this function:

set() [1/2]

mutable_variant_object & fc::mutable_variant_object::set	(	string	key,
		variant	var ) &

replaces the value at key with var or inserts key if not found

replaces the value at key with var or insert's key if not found

Definition at line 341 of file variant_object.cpp.

   {
      auto itr = find( key.c_str() );
      if( itr != end() )
      {
         itr->set( fc::move(var) );
      }
      else
      {
         _key_value->push_back( entry( fc::move(key), fc::move(var) ) );
      }
      return *this;
   }

Here is the caller graph for this function:

set() [2/2]

mutable_variant_object fc::mutable_variant_object::set	(	string	key,
		variant	var ) &&

Definition at line 355 of file variant_object.cpp.

   {
      auto itr = find( key.c_str() );
      if( itr != end() )
      {
         itr->set( fc::move(var) );
      }
      else
      {
         _key_value->push_back( entry( fc::move(key), fc::move(var) ) );
      }
      return std::move(*this);
   }

size()

size_t fc::mutable_variant_object::size

(

)

const

Definition at line 268 of file variant_object.cpp.

   {
      return _key_value->size();
   }

Here is the caller graph for this function:

Friends And Related Symbol Documentation

variant_object

friend class variant_object

friend

Definition at line 238 of file variant_object.hpp.

---

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

• libraries/fc/include/fc/variant_object.hpp
• libraries/fc/src/variant_object.cpp