fc::persistence_util Namespace Reference

Functions
cfile	open_cfile_for_read (const fc::path &dir, const std::string &filename)
uint32_t	read_persistence_header (cfile &dat_content, const uint32_t magic_number, const uint32_t min_supported_version, const uint32_t max_supported_version)
cfile	open_cfile_for_write (const fc::path &dir, const std::string &filename)
void	write_persistence_header (cfile &dat_content, const uint32_t magic_number, const uint32_t current_version)

Detailed Description

This namespace provides functions related to reading and writing a persistence file with a header delineating the type of file and version.

Function Documentation

open_cfile_for_read()

cfile fc::persistence_util::open_cfile_for_read	(	const fc::path &	dir,
		const std::string &	filename )

Definition at line 14 of file persistence_util.hpp.

                                                                           {
      if (!fc::is_directory(dir))
         fc::create_directories(dir);
      
      auto dat_file = dir / filename;
 
      cfile dat_content;
      dat_content.set_file_path(dat_file);
      if( fc::exists( dat_file ) ) {
         dat_content.open(cfile::create_or_update_rw_mode);
      }
      return dat_content;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

open_cfile_for_write()

cfile fc::persistence_util::open_cfile_for_write	(	const fc::path &	dir,
		const std::string &	filename )

Definition at line 58 of file persistence_util.hpp.

                                                                            {
      if (!fc::is_directory(dir))
         fc::create_directories(dir);
 
      auto dat_file = dir / filename;
      cfile dat_content;
      dat_content.set_file_path(dat_file.generic_string().c_str());
      dat_content.open( cfile::truncate_rw_mode );
      return dat_content;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

read_persistence_header()

uint32_t fc::persistence_util::read_persistence_header	(	cfile &	dat_content,
		const uint32_t	magic_number,
		const uint32_t	min_supported_version,
		const uint32_t	max_supported_version )

Definition at line 28 of file persistence_util.hpp.

                                            {
      dat_content.seek(0); // needed on mac
      auto ds = dat_content.create_datastream();
 
      // validate totem
      uint32_t totem = 0;
      fc::raw::unpack( ds, totem );
      if( totem != magic_number) {
         FC_THROW_EXCEPTION(fc::parse_error_exception,
                            "File has unexpected magic number: ${actual_totem}. Expected ${expected_totem}",
                            ("actual_totem", totem)
                            ("expected_totem", magic_number));
      }
 
      // validate version
      uint32_t version = 0;
      fc::raw::unpack( ds, version );
      if( version < min_supported_version || version > max_supported_version) {
         FC_THROW_EXCEPTION(fc::parse_error_exception,
                            "Unsupported version for file. "
                            "Version is ${version} while code supports version(s) [${min},${max}]",
                            ("version", version)
                            ("min", min_supported_version)
                            ("max", max_supported_version));
      }
 
      return version;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

write_persistence_header()

void fc::persistence_util::write_persistence_header	(	cfile &	dat_content,
		const uint32_t	magic_number,
		const uint32_t	current_version )

Definition at line 69 of file persistence_util.hpp.

                                                                                                                  {
      dat_content.write( reinterpret_cast<const char*>(&magic_number), sizeof(magic_number) );
      dat_content.write( reinterpret_cast<const char*>(&current_version), sizeof(current_version) );
   }

Here is the call graph for this function:

Here is the caller graph for this function: