filetransfer.hh

Go to the documentation of this file.

#pragma once
 
#include "lix/libutil/box_ptr.hh"
#include "lix/libutil/ref.hh"
#include "lix/libutil/logging.hh"
#include "lix/libutil/serialise.hh"
#include "lix/libutil/types.hh"
#include "lix/libutil/config.hh"
 
#include <string>
#include <future>
 
namespace nix {
 
struct FileTransferSettings : Config
{
    #include "file-transfer-settings.gen.inc"
};
 
extern FileTransferSettings fileTransferSettings;
 
struct FileTransferResult
{
    bool cached = false;
    std::string etag;
    std::string effectiveUri;
    /* An "immutable" URL for this resource (i.e. one whose contents
       will never change), as returned by the `Link: <url>;
       rel="immutable"` header. */
    std::optional<std::string> immutableUrl;
};
 
class Store;
 
struct FileTransfer
{
    virtual ~FileTransfer() { }

    virtual void
    upload(const std::string & uri, std::string data, const Headers & headers = {}) = 0;

    virtual bool exists(const std::string & uri, const Headers & headers = {}) = 0;

    virtual std::pair<FileTransferResult, box_ptr<Source>>
    download(const std::string & uri, const Headers & headers = {}) = 0;
 
    enum Error { NotFound, Forbidden, Misc, Transient, Interrupted };
};

ref<FileTransfer> getFileTransfer();

ref<FileTransfer> makeFileTransfer(std::optional<unsigned int> baseRetryTimeMs = {});
 
class FileTransferError : public Error
{
public:
    FileTransfer::Error error;
    std::optional<std::string> response;
 
    template<typename... Args>
    FileTransferError(FileTransfer::Error error, std::optional<std::string> response, const Args & ... args);
};
 
}