storage.hpp

Go to the documentation of this file.

#pragma once
 
#include <cstdint>
#include <map>
#include <string>
#include <vector>
 
#include "stream.hpp"
#include "error.hpp"
 
namespace edjx {
 
// APIs for interacting with the EDJX Object Store.
namespace storage {
 
    struct StorageResponse {
        std::map<std::string, std::string> headers;
        edjx::stream::ReadStream read_stream;
 
        inline StorageResponse() {}
 
        inline StorageResponse(
            const std::map<std::string, std::string> & headers,
            const edjx::stream::ReadStream & read_stream
        ) : headers(headers),
            read_stream(read_stream) {}
 
        const std::map<std::string, std::string> & get_headers() const;
 
        edjx::error::StreamError read_body(std::vector<uint8_t> & result);
 
        const edjx::stream::ReadStream & get_read_stream() const;
    };
 
    struct StorageResponsePending {
        uint32_t sd;
 
        StorageResponsePending() {}
        StorageResponsePending(uint32_t sd) : sd(sd) {}
 
        edjx::error::StorageError get_storage_response(StorageResponse & result);
    };
 
    struct FileAttributes {
        bool properties_present;
        std::map<std::string, std::string> properties;
        bool default_version_present;
        std::string default_version;
 
        inline FileAttributes() :
            properties_present(false),
            default_version_present(false) {}
 
        inline FileAttributes(
            bool properties_present,
            const std::map<std::string, std::string> & properties,
            bool default_version_present,
            const std::string & default_version
        ) : properties_present(properties_present),
            properties(properties),
            default_version_present(default_version_present),
            default_version(default_version) {}
    };
 
    edjx::error::StorageError get(
        StorageResponse & result,
        const std::string & bucket_id,
        const std::string & file_name
    );
 
    edjx::error::StorageError put(
        StorageResponse & result,
        const std::string & bucket_id,
        const std::string & file_name,
        const std::string & properties,
        const std::vector<uint8_t> contents
    );
 
    edjx::error::StorageError put_streaming(
        StorageResponsePending & response_streaming,
        edjx::stream::WriteStream & write_stream,
        const std::string & bucket_id,
        const std::string & file_name,
        const std::string & properties
    );
 
    edjx::error::StorageError remove(
        StorageResponse result,
        const std::string & bucket_id,
        const std::string & file_name
    );
 
    edjx::error::StorageError get_attributes(
        FileAttributes & result,
        const std::string & bucket_id,
        const std::string & file_name
    );
 
    edjx::error::StorageError set_attributes(
        StorageResponse & result,
        const std::string & bucket_id,
        const std::string & file_name,
        const FileAttributes & attributes
    );
 
}}