pulp::host::GraphSerializer Class Reference

#include <graph_serializer.hpp>

Classes
struct	SaveResult
struct	LoadResult

Public Types
using	MigrationFn

Static Public Member Functions
static int	current_format_version ()
static bool	register_migration (int from_version, int to_version, MigrationFn migration)
static std::string	to_json (const SignalGraph &graph, const std::unordered_map< NodeId, std::pair< float, float > > &editor_layout={})
static const char *	save_code_name (SaveResult::Code code) noexcept
static SaveResult	to_file (const SignalGraph &graph, const std::filesystem::path &path, const std::unordered_map< NodeId, std::pair< float, float > > &editor_layout={})
static LoadResult	from_json (SignalGraph &graph, const std::string &json)
static LoadResult	from_json (SignalGraph &graph, const std::string &json, const GraphLoadOptions &options)
static LoadResult	from_file (SignalGraph &graph, const std::filesystem::path &path, const GraphLoadOptions &options={})

Static Public Attributes
static constexpr std::size_t	max_file_bytes = 64u * 1024u * 1024u

Member Typedef Documentation

MigrationFn

using pulp::host::GraphSerializer::MigrationFn

Initial value:

 
        std::function<bool(const std::string& source_json,
                           std::string& destination_json)>

Member Function Documentation

current_format_version()

int pulp::host::GraphSerializer::current_format_version ( )

static

from_file()

LoadResult pulp::host::GraphSerializer::from_file ( SignalGraph & graph, const std::filesystem::path & path, const GraphLoadOptions & options = {} )

static

from_json() [1/2]

LoadResult pulp::host::GraphSerializer::from_json ( SignalGraph & graph, const std::string & json )

static

from_json() [2/2]

LoadResult pulp::host::GraphSerializer::from_json ( SignalGraph & graph, const std::string & json, const GraphLoadOptions & options )

static

register_migration()

bool pulp::host::GraphSerializer::register_migration ( int from_version, int to_version, MigrationFn migration )

static

save_code_name()

const char * pulp::host::GraphSerializer::save_code_name ( SaveResult::Code code )

staticnoexcept

to_file()

SaveResult pulp::host::GraphSerializer::to_file ( const SignalGraph & graph, const std::filesystem::path & path, const std::unordered_map< NodeId, std::pair< float, float > > & editor_layout = {} )

static

to_json()

std::string pulp::host::GraphSerializer::to_json ( const SignalGraph & graph, const std::unordered_map< NodeId, std::pair< float, float > > & editor_layout = {} )

static

Member Data Documentation

max_file_bytes

std::size_t pulp::host::GraphSerializer::max_file_bytes = 64u * 1024u * 1024u

staticconstexpr

---

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

• /home/runner/work/pulp/pulp/core/host/include/pulp/host/graph_serializer.hpp