capsule.hpp

Go to the documentation of this file.

#pragma once

 
#include <pulp/authoring_capsule/archive.hpp>
#include <pulp/authoring_capsule/limits.hpp>
#include <pulp/authoring_capsule/manifest.hpp>
#include <pulp/authoring_capsule/preview.hpp>
#include <pulp/authoring_capsule/profile_registry.hpp>
#include <pulp/authoring_capsule/signature.hpp>
#include <pulp/authoring_capsule/staging.hpp>
#include <pulp/authoring_capsule/status.hpp>
#include <pulp/runtime/result.hpp>
 
#include <filesystem>
#include <optional>
#include <string>
#include <vector>
 
namespace pulp::authoring_capsule {
 
struct AdmissionOptions {
    CapsuleLimits limits = kCapsuleLimitsV1;
    const SignatureVerifier* verifier = nullptr;
    std::string product;
};

runtime::Result<CapsulePreview, CapsuleError> preview_capsule(const CapsuleArchive& archive,
                                                              const ProfileRegistry& registry,
                                                              const AdmissionOptions& options);

runtime::Result<void, CapsuleError> admit_to_staging(const CapsuleArchive& archive,
                                                     const CapsulePreview& preview,
                                                     const ProfileRegistry& registry,
                                                     const StagingArea& staging,
                                                     const ExtractionProgress& progress = {});

struct ExportItem {
    FileEntry entry;
    std::vector<std::uint8_t> bytes;
};
 
struct ExportRequest {
    Manifest manifest;
    std::vector<ExportItem> items;
};

runtime::Result<std::uint64_t, CapsuleError>
export_capsule(ExportRequest request, const std::filesystem::path& destination,
               const CapsuleLimits& limits = kCapsuleLimitsV1);
 
}  // namespace pulp::authoring_capsule