sysio::chain::symbol Class Reference

#include <symbol.hpp>

Inheritance diagram for sysio::chain::symbol:

Collaboration diagram for sysio::chain::symbol:

Public Member Functions
	symbol (uint8_t p, const char *s)
	symbol (uint64_t v=CORE_SYMBOL)
uint64_t	value () const
bool	valid () const
uint8_t	decimals () const
uint64_t	precision () const
string	name () const
symbol_code	to_symbol_code () const
	operator string () const
string	to_string () const
void	reflector_init () const

Static Public Member Functions
static symbol	from_string (const string &from)
static bool	valid_name (const string &name)

Static Public Attributes
static constexpr uint8_t	max_precision = 18

Friends
struct	fc::reflector< symbol >
template<typename DataStream >
DataStream &	operator<< (DataStream &ds, const symbol &s)

Detailed Description

Definition at line 57 of file symbol.hpp.

Constructor & Destructor Documentation

symbol() [1/2]

sysio::chain::symbol::symbol ( uint8_t p, const char * s )

inlineexplicit

Definition at line 62 of file symbol.hpp.

                                                     : m_value(string_to_symbol(p, s)) {
               SYS_ASSERT(valid(), symbol_type_exception, "invalid symbol: ${s}", ("s",s));
            }

Here is the call graph for this function:

Here is the caller graph for this function:

symbol() [2/2]

sysio::chain::symbol::symbol ( uint64_t v = CORE_SYMBOL )

inlineexplicit

Definition at line 65 of file symbol.hpp.

                                                     : m_value(v) {
               SYS_ASSERT(valid(), symbol_type_exception, "invalid symbol: ${name}", ("name",name()));
            }

Here is the call graph for this function:

Member Function Documentation

decimals()

uint8_t sysio::chain::symbol::decimals ( ) const

inline

Definition at line 93 of file symbol.hpp.

{ return m_value & 0xFF; }

Here is the caller graph for this function:

from_string()

static symbol sysio::chain::symbol::from_string ( const string & from )

inlinestatic

Definition at line 68 of file symbol.hpp.

            {
               try {
                  string s = fc::trim(from);
                  SYS_ASSERT(!s.empty(), symbol_type_exception, "creating symbol from empty string");
                  auto comma_pos = s.find(',');
                  SYS_ASSERT(comma_pos != string::npos, symbol_type_exception, "missing comma in symbol");
                  auto prec_part = s.substr(0, comma_pos);
                  uint8_t p = fc::to_int64(prec_part);
                  string name_part = s.substr(comma_pos + 1);
                  SYS_ASSERT( p <= max_precision, symbol_type_exception, "precision ${p} should be <= 18", ("p", p));
                  return symbol(string_to_symbol(p, name_part.c_str()));
               } FC_CAPTURE_LOG_AND_RETHROW((from))
            }

Here is the call graph for this function:

Here is the caller graph for this function:

name()

string sysio::chain::symbol::name ( ) const

inline

Definition at line 104 of file symbol.hpp.

            {
               uint64_t v = m_value;
               v >>= 8;
               string result;
               while (v > 0) {
                  char c = v & 0xFF;
                  result += c;
                  v >>= 8;
               }
               return result;
            }

Here is the caller graph for this function:

operator string()

sysio::chain::symbol::operator string ( ) const

inlineexplicit

Definition at line 119 of file symbol.hpp.

            {
               uint64_t v = m_value;
               uint8_t p = v & 0xFF;
               string ret = sysio::chain::to_string(p);
               ret += ',';
               ret += name();
               return ret;
            }

Here is the call graph for this function:

precision()

uint64_t sysio::chain::symbol::precision ( ) const

inline

Definition at line 94 of file symbol.hpp.

            {
               SYS_ASSERT( decimals() <= max_precision, symbol_type_exception, "precision ${p} should be <= 18", ("p", decimals()) );
               uint64_t p10 = 1;
               uint64_t p = decimals();
               while( p > 0  ) {
                  p10 *= 10; --p;
               }
               return p10;
            }

Here is the call graph for this function:

Here is the caller graph for this function:

reflector_init()

void sysio::chain::symbol::reflector_init ( ) const

inline

Definition at line 136 of file symbol.hpp.

                                       {
               SYS_ASSERT( decimals() <= max_precision, symbol_type_exception, "precision ${p} should be <= 18", ("p", decimals()) );
               SYS_ASSERT( valid_name(name()), symbol_type_exception, "invalid symbol: ${name}", ("name",name()));
            }

Here is the call graph for this function:

to_string()

string sysio::chain::symbol::to_string ( ) const

inline

Definition at line 129 of file symbol.hpp.

{ return string(*this); }

Here is the caller graph for this function:

to_symbol_code()

symbol_code sysio::chain::symbol::to_symbol_code ( ) const

inline

Definition at line 117 of file symbol.hpp.

{ return {m_value >> 8}; }

Here is the caller graph for this function:

valid()

bool sysio::chain::symbol::valid ( ) const

inline

Definition at line 83 of file symbol.hpp.

            {
               const auto& s = name();
               return decimals() <= max_precision && valid_name(s);
            }

Here is the call graph for this function:

Here is the caller graph for this function:

valid_name()

static bool sysio::chain::symbol::valid_name ( const string & name )

inlinestatic

Definition at line 88 of file symbol.hpp.

            {
               return all_of(name.begin(), name.end(), [](char c)->bool { return (c >= 'A' && c <= 'Z'); });
            }

Here is the caller graph for this function:

value()

uint64_t sysio::chain::symbol::value ( ) const

inline

Definition at line 82 of file symbol.hpp.

{ return m_value; }

Here is the caller graph for this function:

Friends And Related Symbol Documentation

fc::reflector< symbol >

friend struct fc::reflector< symbol >

friend

Definition at line 142 of file symbol.hpp.

operator<<

template<typename DataStream >

DataStream & operator<< ( DataStream & ds, const symbol & s )

friend

Definition at line 131 of file symbol.hpp.

            {
               return ds << s.to_string();
            }

Member Data Documentation

max_precision

uint8_t sysio::chain::symbol::max_precision = 18

staticconstexpr

Definition at line 60 of file symbol.hpp.

---

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

• libraries/chain/include/sysio/chain/symbol.hpp