include/fsdk/IImageTransfer.h

#pragma once

#include <fsdk/FSDKError.h>
#include <fsdk/Types.h>

#include <fsdk/vlc/future.h>

#include <fsdk/IImagesBatch.h>

namespace fsdk {

#ifndef DOXYGEN_SHOULD_SKIP_THIS
    DECLARE_SMARTPTR(IImageTransfer);
#endif

    struct IImageTransfer : IRefCounted {

        virtual ResultValue<FSDKError, Ref<IImagesBatch>>
        transfer(Span<const Image> images, Image::MemoryResidence residence) const noexcept = 0;

        virtual Result<FSDKError> validate(
            Span<const Image> images,
            Image::MemoryResidence residence,
            Span<Result<FSDKError>> errors) const noexcept = 0;

        using ImagesBatchFuture = vlc::future<IImagesBatchPtr>;

        virtual ImagesBatchFuture
        transferAsync(Span<const Image> images, Image::MemoryResidence residence) const = 0;
    };

} // namespace fsdk