export_plan.hpp File Reference

#include <pulp/interchange/capability.hpp>
#include <pulp/interchange/census.hpp>
#include <pulp/interchange/concept.hpp>
#include <pulp/interchange/loss.hpp>
#include <pulp/runtime/result.hpp>
#include <pulp/timeline/model.hpp>
#include <cstdint>
#include <functional>
#include <span>
#include <string>
#include <utility>
#include <vector>

Go to the source code of this file.

Classes
struct	pulp::interchange::ExportArtifact
	What one export produced. More...
struct	pulp::interchange::ExportArtifacts
struct	pulp::interchange::ExportError
struct	pulp::interchange::ExportOptions
class	pulp::interchange::ExportPlan
	A document measured against one format's capability table: what survives, and what it costs. More...
class	pulp::interchange::FormatBoundExportWriter
	A format-bound byte writer that can only be invoked by run_export. More...

Namespaces
namespace	pulp
namespace	pulp::interchange

Typedefs
using	pulp::interchange::ExportWriter
	The released v0.759 writer seam.

Enumerations
enum class	pulp::interchange::ExportErrorCode : std::uint8_t { pulp::interchange::UnacceptedLoss , pulp::interchange::NoWriterRegistered , pulp::interchange::WriterFailed , pulp::interchange::WriterFormatMismatch }

Functions
ExportPlan	pulp::interchange::plan_export (const timeline::Project &project, Format format, const CensusLimits &limits={})
	Measure a document against a format.
std::string	pulp::interchange::loss_manifest_json (const ExportPlan &plan)
	Serialize the canonical loss manifest carried by every plan and export result.
runtime::Result< ExportArtifacts, ExportError >	pulp::interchange::run_export (const ExportPlan &plan, const ExportOptions &options, const ExportWriter &writer)
	Execute a plan.
runtime::Result< ExportArtifacts, ExportError >	pulp::interchange::run_export (const ExportPlan &plan, const ExportOptions &options, const FormatBoundExportWriter &writer)
	Execute through a format-bound writer.