Flip Reference

previous next

DataConsumerFile Class Reference

Declared in

flip/contrib/DataConsumerFile.h

class DataConsumerFile;

Note: Classes part of contrib/ are not supported on every platform. This class is not supported on the WinRT platform.

Generally a data consumer represents an abstraction of output serialized data that is platform (endianess and word size) independent.

flip::DataConsumerFile is a specialization of data consumer which output is a file.

Internally the data is presented in big-endian, and has byte alignment packing.

To output to memory instead of a file, see flip::DataConsumerMemory

Member Functions Synopsys

Constructor

Constructs the DataConsumerFile

Destructor

Destructs the DataConsumerFile

operator <<

Inserts value in the consumer

push

Inserts raw data in the consumer

Member Functions

Constructor

DataConsumerFile (const char * path_0);

Constructor. The output of serialization will be done to the file with path the null terminated string path_0.

Important: The encoding of path_0 is UTF-8

The path should make possible to open a file for writing. If any error occurs, the constructor will throw std::runtime_error.

Destructor

~DataConsumerFile ();

Destructor.

operator <<

DataConsumerFile & operator << (bool val);                (1)
DataConsumerFile & operator << (char val);                (1)
DataConsumerFile & operator << (uint8_t val);             (1)
DataConsumerFile & operator << (int32_t val);             (1)
DataConsumerFile & operator << (uint32_t val);            (1)
DataConsumerFile & operator << (int64_t val);             (1)
DataConsumerFile & operator << (uint64_t val);            (1)
DataConsumerFile & operator << (double val);              (1)
DataConsumerFile & operator << (const char * val_0);      (2)
DataConsumerFile & operator << (const std::string & val); (3)

Inserts value into the consumer.

  1. Inserts value into the consumer and perform automatic byte swapping and packing.
  2. Inserts the null terminated string into the consumer.
  3. Inserts the string into the consumer.

Important: String insertions do not contain the dynamic string size.

Example :

std::vector <uint8_t> data;
DataConsumerMemory consumer (data);


std::string str ("Flip");




consumer << true;


consumer << int32_t (2);


consumer << 2.5;




consumer << uint64_t (str.size ());


consumer << str;




DataProviderMemory provider (data);


bool val_b;


int32_t val_i;


double val_d;


std::string val_s;




consumer >> val_b; // true


consumer >> val_i; // 2


consumer >> val_d; // 2.5




uint64_t str_size;


consumer >> str_size;


val_s = consumer.read_string (str_size);   // "Flip"




char val_c;


consumer >> val_c; // throws std::runtime_error





push




void  push (const uint8_t * data_ptr, size_t data_size)





Inserts raw data into the consumer. No byte swap is performed and the packing of data is not changed.



Important: The insertion does not include the data size.




previous next