staging.hpp

Go to the documentation of this file.

#pragma once

 
#include <pulp/authoring_capsule/archive.hpp>
#include <pulp/authoring_capsule/manifest.hpp>
#include <pulp/authoring_capsule/status.hpp>
#include <pulp/runtime/result.hpp>
 
#include <cstdint>
#include <filesystem>
#include <functional>
#include <memory>
#include <string>
#include <vector>
 
namespace pulp::authoring_capsule {

class StagingArea {
public:
    static runtime::Result<StagingArea, CapsuleError> create(const std::filesystem::path& parent);
 
    StagingArea(StagingArea&&) noexcept;
    StagingArea& operator=(StagingArea&&) noexcept;
    StagingArea(const StagingArea&) = delete;
    StagingArea& operator=(const StagingArea&) = delete;
    ~StagingArea();
 
    const std::filesystem::path& root() const noexcept;

    runtime::Result<void, CapsuleError> publish_no_replace(const std::filesystem::path& destination);
 
private:
    struct Impl;
    explicit StagingArea(std::unique_ptr<Impl> impl);
    std::unique_ptr<Impl> impl_;
};

using ExtractionProgress = std::function<bool(std::size_t member_index, std::size_t member_count)>;

runtime::Result<void, CapsuleError> extract_declared(const CapsuleArchive& archive,
                                                     const Manifest& manifest,
                                                     const StagingArea& staging,
                                                     const ExtractionProgress& progress = {});

runtime::Result<std::vector<std::uint8_t>, CapsuleError>
read_staged_member(const StagingArea& staging, const FileEntry& entry);

runtime::Result<std::vector<std::uint8_t>, CapsuleError>
read_staged_member(const std::filesystem::path& staging_root, const FileEntry& entry);
 
}  // namespace pulp::authoring_capsule