atomic_publisher.hpp

Go to the documentation of this file.

#pragma once
 
#include <pulp/runtime/result.hpp>
 
#include <cstdint>
#include <filesystem>
#include <memory>
#include <span>
#include <string>
#include <string_view>
 
namespace pulp::project_package {

enum class PackageErrorCode : std::uint8_t {
    InvalidPath,
    InvalidLayout,
    AlreadyOpen,
    HashMismatch,
    IoError,
    PublicationConflict,
    DurabilityUncertain,
    InvalidGeneration,
    LimitExceeded,
};

struct PackageError {
    PackageErrorCode code = PackageErrorCode::IoError;
    std::filesystem::path path;
};

enum class AtomicPublishOutcome : std::uint8_t {
    NotPublished,
    PublishedDurably,
    PublishedDurabilityUncertain,
};

class AtomicPublisher {
  public:
    static runtime::Result<AtomicPublisher, PackageError>
    create(const std::filesystem::path& destination) noexcept;
    static runtime::Result<AtomicPublisher, PackageError>
    create_file(const std::filesystem::path& destination) noexcept;
 
    ~AtomicPublisher();
    AtomicPublisher(AtomicPublisher&&) noexcept;
    AtomicPublisher& operator=(AtomicPublisher&&) noexcept;
    AtomicPublisher(const AtomicPublisher&) = delete;
    AtomicPublisher& operator=(const AtomicPublisher&) = delete;

    const std::filesystem::path& staging_directory() const noexcept;
    const std::filesystem::path& staging_file() const noexcept;
    runtime::Result<bool, PackageError> write(std::string_view relative_utf8,
                                              std::span<const std::uint8_t> bytes) noexcept;
    runtime::Result<bool, PackageError> write(std::string_view relative_utf8,
                                              std::string_view text) noexcept;
    runtime::Result<AtomicPublishOutcome, PackageError>
    commit_file(const std::filesystem::path& staged_file) noexcept;
    runtime::Result<AtomicPublishOutcome, PackageError> commit_directory() noexcept;
    void cancel() noexcept;
 
  private:
    struct Impl;
    static runtime::Result<AtomicPublisher, PackageError>
    create_impl(const std::filesystem::path& destination, bool file) noexcept;
    explicit AtomicPublisher(std::unique_ptr<Impl> impl) noexcept;
    std::unique_ptr<Impl> impl_;
};
 
} // namespace pulp::project_package