downloader.hpp

Go to the documentation of this file.

// Copyright 2009-present MongoDB, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#pragma once
 
#include <mongocxx/v1/gridfs/downloader-fwd.hpp> // IWYU pragma: export
 
//
 
#include <mongocxx/v1/detail/prelude.hpp>
 
#include <bsoncxx/v1/document/view-fwd.hpp>
 
#include <mongocxx/v1/config/export.hpp>
 
#include <cstddef>
#include <cstdint>
#include <system_error>
#include <type_traits>
 
namespace mongocxx {
namespace v1 {
namespace gridfs {

class downloader {
   private:
    class impl;
    void* _impl;
 
   public:
    MONGOCXX_ABI_EXPORT_CDECL() ~downloader();

    MONGOCXX_ABI_EXPORT_CDECL() downloader(downloader&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL(downloader&) operator=(downloader&& other) noexcept;

    downloader(downloader const& other) = delete;

    downloader& operator=(downloader const& other) = delete;

    MONGOCXX_ABI_EXPORT_CDECL() downloader();

    explicit MONGOCXX_ABI_EXPORT_CDECL() operator bool() const;

    MONGOCXX_ABI_EXPORT_CDECL(bool) is_open() const;

    MONGOCXX_ABI_EXPORT_CDECL(void) close();

    MONGOCXX_ABI_EXPORT_CDECL(std::int32_t) chunk_size() const;

    MONGOCXX_ABI_EXPORT_CDECL(std::int64_t) file_length() const;

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::document::view) files_document() const;

    MONGOCXX_ABI_EXPORT_CDECL(std::size_t) read(std::uint8_t* data, std::size_t length);

    enum class errc {
        zero,         
        is_closed,    
        corrupt_data, 
    };

    static MONGOCXX_ABI_EXPORT_CDECL(std::error_category const&) error_category();

    friend std::error_code make_error_code(errc v) {
        return {static_cast<int>(v), error_category()};
    }
 
    class internal;
 
   private:
    /* explicit(false) */ downloader(void* impl);
 
    void download_next_chunk();
};
 
} // namespace gridfs
} // namespace v1
} // namespace mongocxx
 
namespace std {
 
template <>
struct is_error_code_enum<mongocxx::v1::gridfs::downloader::errc> : true_type {};
 
} // namespace std
 
#include <mongocxx/v1/detail/postlude.hpp>