fc::variant_object Class Reference

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

#include <variant_object.hpp>

Classes
class	entry
	a key/value pair More...

Public Types
typedef std::vector< entry >::const_iterator	iterator

Public Member Functions
	variant_object ()
	variant_object (string key, variant val)
template<typename T >
	variant_object (string key, T &&val)
	variant_object (const variant_object &)
	variant_object (variant_object &&)
	variant_object (const mutable_variant_object &)
	variant_object (mutable_variant_object &&)
variant_object &	operator= (variant_object &&)
variant_object &	operator= (const variant_object &)
variant_object &	operator= (mutable_variant_object &&)
variant_object &	operator= (const mutable_variant_object &)
size_t	estimated_size () const
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
bool	contains (const char *key) const

Friends
class	mutable_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 20 of file variant_object.hpp.

Member Typedef Documentation

iterator

std::vector<entry>::const_iterator fc::variant_object::iterator

Definition at line 52 of file variant_object.hpp.

Constructor & Destructor Documentation

variant_object() [1/7]

fc::variant_object::variant_object

(

)

Definition at line 97 of file variant_object.cpp.

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

Here is the caller graph for this function:

variant_object() [2/7]

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

initializes the first key/value pair in the object

Definition at line 102 of file variant_object.cpp.

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

variant_object() [3/7]

template<typename T >

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

inline

Definition at line 77 of file variant_object.hpp.

      :_key_value( std::make_shared<std::vector<entry> >() )
      {
         *this = variant_object( std::move(key), variant(forward<T>(val)) );
      }

Here is the call graph for this function:

variant_object() [4/7]

fc::variant_object::variant_object

(

const variant_object &

obj

)

Definition at line 109 of file variant_object.cpp.

   :_key_value( obj._key_value )
   {
      FC_ASSERT( _key_value != nullptr );
   }

variant_object() [5/7]

fc::variant_object::variant_object

(

variant_object &&

obj

)

Definition at line 115 of file variant_object.cpp.

   : _key_value( fc::move(obj._key_value) )
   {
      obj._key_value = std::make_shared<std::vector<entry>>();
      FC_ASSERT( _key_value != nullptr );
   }

variant_object() [6/7]

fc::variant_object::variant_object

(

const mutable_variant_object &

obj

)

Definition at line 122 of file variant_object.cpp.

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

variant_object() [7/7]

fc::variant_object::variant_object

(

mutable_variant_object &&

obj

)

Definition at line 127 of file variant_object.cpp.

   : _key_value(fc::move(obj._key_value))
   {
      FC_ASSERT( _key_value != nullptr );
   }

Member Function Documentation

begin()

variant_object::iterator fc::variant_object::begin

(

)

const

Definition at line 52 of file variant_object.cpp.

   {
      FC_ASSERT( _key_value != nullptr );
      return _key_value->begin();
   }

Here is the caller graph for this function:

contains()

bool fc::variant_object::contains ( const char * key ) const

inline

Definition at line 68 of file variant_object.hpp.

{ return find(key) != end(); }

Here is the call graph for this function:

Here is the caller graph for this function:

end()

variant_object::iterator fc::variant_object::end

(

)

const

Definition at line 58 of file variant_object.cpp.

   {
      return _key_value->end();
   }

Here is the caller graph for this function:

estimated_size()

size_t fc::variant_object::estimated_size

(

)

const

Definition at line 165 of file variant_object.cpp.

   {
      auto kv_size = size();
      size_t sum = sizeof(*this) + sizeof(std::vector<entry>);
      for (size_t iter = 0; iter < kv_size; ++iter) {
         const auto& kv = _key_value->at(iter);
         sum += kv.key().length() + sizeof(string);
         sum += kv.value().estimated_size();
      }
      return sum;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

find() [1/2]

variant_object::iterator fc::variant_object::find

(

const char *

key

)

const

Definition at line 68 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/2]

variant_object::iterator fc::variant_object::find

(

const string &

key

)

const

Definition at line 63 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/4]

variant_object & fc::variant_object::operator=

(

const mutable_variant_object &

obj

)

Definition at line 159 of file variant_object.cpp.

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

operator=() [2/4]

variant_object & fc::variant_object::operator=

(

const variant_object &

obj

)

Definition at line 143 of file variant_object.cpp.

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

operator=() [3/4]

variant_object & fc::variant_object::operator=

(

mutable_variant_object &&

obj

)

Definition at line 152 of file variant_object.cpp.

   {
      _key_value = fc::move(obj._key_value);
      obj._key_value.reset( new std::vector<entry>() );
      return *this;
   }

operator=() [4/4]

variant_object & fc::variant_object::operator=

(

variant_object &&

obj

)

Definition at line 133 of file variant_object.cpp.

   {
      if (this != &obj)
      {
         fc_swap(_key_value, obj._key_value );
         FC_ASSERT( _key_value != nullptr );
      }
      return *this;
   }

Here is the call graph for this function:

operator[]() [1/2]

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

(

const char *

key

)

const

Definition at line 85 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[]() [2/2]

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

(

const string &

key

)

const

Definition at line 80 of file variant_object.cpp.

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

size()

size_t fc::variant_object::size

(

)

const

Definition at line 92 of file variant_object.cpp.

   {
      return _key_value->size();
   }

Here is the caller graph for this function:

Friends And Related Symbol Documentation

mutable_variant_object

friend class mutable_variant_object

friend

Definition at line 98 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