bucket.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/bucket-fwd.hpp> // IWYU pragma: export
 
//
 
#include <mongocxx/v1/detail/prelude.hpp>
 
#include <bsoncxx/v1/document/view-fwd.hpp>
#include <bsoncxx/v1/types/view-fwd.hpp>
 
#include <mongocxx/v1/client_session-fwd.hpp>
#include <mongocxx/v1/cursor-fwd.hpp>
#include <mongocxx/v1/gridfs/downloader-fwd.hpp>
#include <mongocxx/v1/gridfs/upload_result-fwd.hpp>
#include <mongocxx/v1/gridfs/uploader-fwd.hpp>
#include <mongocxx/v1/read_concern-fwd.hpp>
#include <mongocxx/v1/read_preference-fwd.hpp>
#include <mongocxx/v1/write_concern-fwd.hpp>
 
#include <bsoncxx/v1/stdx/optional.hpp>
#include <bsoncxx/v1/stdx/string_view.hpp>
 
#include <mongocxx/v1/config/export.hpp>
#include <mongocxx/v1/find_options.hpp>
#include <mongocxx/v1/gridfs/upload_options.hpp>
 
#include <cstddef>
#include <cstdint>
#include <istream>
#include <ostream>
#include <string>
#include <system_error>
#include <type_traits>
 
namespace mongocxx {
namespace v1 {
namespace gridfs {

class bucket {
   private:
    class impl;
    void* _impl;
 
   public:
    class options;

    MONGOCXX_ABI_EXPORT_CDECL() ~bucket();

    MONGOCXX_ABI_EXPORT_CDECL() bucket(bucket&& other) noexcept;

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

    MONGOCXX_ABI_EXPORT_CDECL() bucket(bucket const& other);

    MONGOCXX_ABI_EXPORT_CDECL(bucket&) operator=(bucket const& other);

    MONGOCXX_ABI_EXPORT_CDECL() bucket();

    explicit MONGOCXX_ABI_EXPORT_CDECL() operator bool() const;

    MONGOCXX_ABI_EXPORT_CDECL(v1::gridfs::uploader) open_upload_stream(
        bsoncxx::v1::stdx::string_view filename,
        v1::gridfs::upload_options const& opts = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(v1::gridfs::uploader) open_upload_stream(
        v1::client_session const& session,
        bsoncxx::v1::stdx::string_view filename,
        v1::gridfs::upload_options const& opts = {});

    MONGOCXX_ABI_EXPORT_CDECL(v1::gridfs::uploader) open_upload_stream_with_id(
        bsoncxx::v1::types::view id,
        bsoncxx::v1::stdx::string_view filename,
        v1::gridfs::upload_options const& opts = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(v1::gridfs::uploader) open_upload_stream_with_id(
        v1::client_session const& session,
        bsoncxx::v1::types::view id,
        bsoncxx::v1::stdx::string_view filename,
        v1::gridfs::upload_options const& opts = {});

    MONGOCXX_ABI_EXPORT_CDECL(v1::gridfs::upload_result) upload_from_stream(
        bsoncxx::v1::stdx::string_view filename,
        std::istream& input,
        v1::gridfs::upload_options const& opts = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(v1::gridfs::upload_result) upload_from_stream(
        v1::client_session const& session,
        bsoncxx::v1::stdx::string_view filename,
        std::istream& input,
        v1::gridfs::upload_options const& opts = {});

    MONGOCXX_ABI_EXPORT_CDECL(void) upload_from_stream_with_id(
        bsoncxx::v1::types::view id,
        bsoncxx::v1::stdx::string_view filename,
        std::istream& input,
        v1::gridfs::upload_options const& opts = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(void) upload_from_stream_with_id(
        v1::client_session const& session,
        bsoncxx::v1::types::view id,
        bsoncxx::v1::stdx::string_view filename,
        std::istream& input,
        v1::gridfs::upload_options const& opts = {});

    MONGOCXX_ABI_EXPORT_CDECL(v1::gridfs::downloader) open_download_stream(bsoncxx::v1::types::view id);
 
    MONGOCXX_ABI_EXPORT_CDECL(v1::gridfs::downloader) open_download_stream(
        v1::client_session const& session,
        bsoncxx::v1::types::view id);

    MONGOCXX_ABI_EXPORT_CDECL(void) download_to_stream(bsoncxx::v1::types::view id, std::ostream& output);
 
    MONGOCXX_ABI_EXPORT_CDECL(void)
    download_to_stream(v1::client_session const& session, bsoncxx::v1::types::view id, std::ostream& output);

    MONGOCXX_ABI_EXPORT_CDECL(void)
    download_to_stream(bsoncxx::v1::types::view id, std::ostream& output, std::size_t start, std::size_t end);
 
    MONGOCXX_ABI_EXPORT_CDECL(void) download_to_stream(
        v1::client_session const& session,
        bsoncxx::v1::types::view id,
        std::ostream& output,
        std::size_t start,
        std::size_t end);

    MONGOCXX_ABI_EXPORT_CDECL(void) delete_file(bsoncxx::v1::types::view id);
 
    MONGOCXX_ABI_EXPORT_CDECL(void) delete_file(v1::client_session const& session, bsoncxx::v1::types::view id);

    MONGOCXX_ABI_EXPORT_CDECL(v1::cursor) find(bsoncxx::v1::document::view filter, v1::find_options const& opts = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(v1::cursor)
    find(v1::client_session const& session, bsoncxx::v1::document::view filter, v1::find_options const& opts = {});

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::string_view) bucket_name() const;

    enum class errc {
        zero,                     
        invalid_bucket_name,      
        invalid_chunk_size_bytes, 
        not_found,                
        corrupt_data,             
        invalid_byte_range, 
    };

    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) */ bucket(void* impl);
};

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

    MONGOCXX_ABI_EXPORT_CDECL() options(options&& other) noexcept;

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

    MONGOCXX_ABI_EXPORT_CDECL() options(options const& other);

    MONGOCXX_ABI_EXPORT_CDECL(options&) operator=(options const& other);

    MONGOCXX_ABI_EXPORT_CDECL() options();

    MONGOCXX_ABI_EXPORT_CDECL(options&) bucket_name(std::string v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::stdx::string_view>) bucket_name() const;

    MONGOCXX_ABI_EXPORT_CDECL(options&) chunk_size_bytes(std::int32_t v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<std::int32_t>) chunk_size_bytes() const;

    MONGOCXX_ABI_EXPORT_CDECL(options&) read_concern(v1::read_concern v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<v1::read_concern>) read_concern() const;

    MONGOCXX_ABI_EXPORT_CDECL(options&) read_preference(v1::read_preference v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<v1::read_preference>) read_preference() const;

    MONGOCXX_ABI_EXPORT_CDECL(options&) write_concern(v1::write_concern v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<v1::write_concern>) write_concern() const;
 
    class internal;
 
   private:
    /* explicit(false) */ options(void* impl);
};
 
} // namespace gridfs
} // namespace v1
} // namespace mongocxx
 
namespace std {
 
template <>
struct is_error_code_enum<mongocxx::v1::gridfs::bucket::errc> : true_type {};
 
} // namespace std
 
#include <mongocxx/v1/detail/postlude.hpp>