CatapultServer  v0.5.0.1 (Elephant)
catapult::model::SizePrefixedEntity Struct Reference

Binary layout for a size prefixed entity. More...

Inheritance diagram for catapult::model::SizePrefixedEntity:
Collaboration diagram for catapult::model::SizePrefixedEntity:

Public Member Functions

bool operator== (const SizePrefixedEntity &rhs) const
 Returns true if this entity is equal to rhs. More...
 
bool operator!= (const SizePrefixedEntity &rhs) const
 Returns true if this entity is not equal to rhs. More...
 
- Public Member Functions inherited from catapult::utils::NonCopyable
constexpr NonCopyable ()=default
 Default constructor. More...
 
 ~NonCopyable ()=default
 Default destructor. More...
 
 NonCopyable (const NonCopyable &)=delete
 Disabled copy constructor. More...
 
NonCopyableoperator= (const NonCopyable &)=delete
 Disabled assignment operator. More...
 

Public Attributes

uint32_t Size
 Entity size. More...
 

Protected Member Functions

const uint8_t * ToBytePointer () const
 Returns byte-based const pointer to this entity. More...
 
uint8_t * ToBytePointer ()
 Returns byte-based pointer to this entity. More...
 

Static Protected Member Functions

template<typename T >
static auto PayloadStart (T &entity)
 Gets the start of the variable data part of entity. More...
 

Detailed Description

Binary layout for a size prefixed entity.

Member Function Documentation

◆ operator!=()

bool catapult::model::SizePrefixedEntity::operator!= ( const SizePrefixedEntity rhs) const

Returns true if this entity is not equal to rhs.

◆ operator==()

bool catapult::model::SizePrefixedEntity::operator== ( const SizePrefixedEntity rhs) const

Returns true if this entity is equal to rhs.

◆ PayloadStart()

template<typename T >
static auto catapult::model::SizePrefixedEntity::PayloadStart ( T &  entity)
inlinestaticprotected

Gets the start of the variable data part of entity.

◆ ToBytePointer() [1/2]

uint8_t * catapult::model::SizePrefixedEntity::ToBytePointer ( )
protected

Returns byte-based pointer to this entity.

◆ ToBytePointer() [2/2]

const uint8_t * catapult::model::SizePrefixedEntity::ToBytePointer ( ) const
protected

Returns byte-based const pointer to this entity.

Member Data Documentation

◆ Size

uint32_t catapult::model::SizePrefixedEntity::Size

Entity size.


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