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/gridfs/bucket-fwd.hpp> // IWYU pragma: export
 
//
 
#include <mongocxx/v1/gridfs/bucket.hpp> // IWYU pragma: export
 
#include <cstddef>
#include <istream>
#include <memory> // IWYU pragma: keep: backward compatibility, to be removed.
#include <ostream>
#include <utility>
 
#include <mongocxx/database-fwd.hpp> // IWYU pragma: keep: backward compatibility, to be removed.
 
#include <bsoncxx/document/view_or_value.hpp>
#include <bsoncxx/stdx/optional.hpp> // IWYU pragma: keep: backward compatibility, to be removed.
#include <bsoncxx/stdx/string_view.hpp>
#include <bsoncxx/types/bson_value/view.hpp>
 
#include <mongocxx/client_session.hpp>
#include <mongocxx/cursor.hpp>
#include <mongocxx/gridfs/downloader.hpp>
#include <mongocxx/gridfs/uploader.hpp>
#include <mongocxx/options/find.hpp>
#include <mongocxx/options/gridfs/bucket.hpp> // IWYU pragma: keep: backward compatibility, to be removed.
#include <mongocxx/options/gridfs/upload.hpp>
#include <mongocxx/result/gridfs/upload.hpp>
 
#include <mongocxx/config/prelude.hpp>
 
namespace mongocxx {
namespace v_noabi {
namespace gridfs {

class bucket {
   private:
    v1::gridfs::bucket _bucket;
 
   public:
    bucket() noexcept {}

    bucket(bucket&& other) noexcept = default;

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

    MONGOCXX_ABI_EXPORT_CDECL() bucket(bucket const& other);

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

    ~bucket() = default;

    /* explicit(false) */ bucket(v1::gridfs::bucket bucket) : _bucket{std::move(bucket)} {}

    explicit operator v1::gridfs::bucket() && {
        return std::move(_bucket);
    }

    explicit operator v1::gridfs::bucket() const& {
        return _bucket;
    }

    explicit operator bool() const noexcept {
        return _bucket.operator bool();
    }

    MONGOCXX_ABI_EXPORT_CDECL(v_noabi::gridfs::uploader)
    open_upload_stream(
        bsoncxx::v_noabi::stdx::string_view filename,
        v_noabi::options::gridfs::upload const& options = {});

    MONGOCXX_ABI_EXPORT_CDECL(v_noabi::gridfs::uploader)
    open_upload_stream(
        v_noabi::client_session const& session,
        bsoncxx::v_noabi::stdx::string_view filename,
        v_noabi::options::gridfs::upload const& options = {});

    MONGOCXX_ABI_EXPORT_CDECL(v_noabi::gridfs::uploader)
    open_upload_stream_with_id(
        bsoncxx::v_noabi::types::view id,
        bsoncxx::v_noabi::stdx::string_view filename,
        v_noabi::options::gridfs::upload const& options = {});

    MONGOCXX_ABI_EXPORT_CDECL(v_noabi::gridfs::uploader)
    open_upload_stream_with_id(
        v_noabi::client_session const& session,
        bsoncxx::v_noabi::types::view id,
        bsoncxx::v_noabi::stdx::string_view filename,
        v_noabi::options::gridfs::upload const& options = {});

    MONGOCXX_ABI_EXPORT_CDECL(v_noabi::result::gridfs::upload)
    upload_from_stream(
        bsoncxx::v_noabi::stdx::string_view filename,
        std::istream* source,
        v_noabi::options::gridfs::upload const& options = {});

    MONGOCXX_ABI_EXPORT_CDECL(v_noabi::result::gridfs::upload)
    upload_from_stream(
        v_noabi::client_session const& session,
        bsoncxx::v_noabi::stdx::string_view filename,
        std::istream* source,
        v_noabi::options::gridfs::upload const& options = {});

    MONGOCXX_ABI_EXPORT_CDECL(void)
    upload_from_stream_with_id(
        bsoncxx::v_noabi::types::view id,
        bsoncxx::v_noabi::stdx::string_view filename,
        std::istream* source,
        v_noabi::options::gridfs::upload const& options = {});

    MONGOCXX_ABI_EXPORT_CDECL(void)
    upload_from_stream_with_id(
        v_noabi::client_session const& session,
        bsoncxx::v_noabi::types::view id,
        bsoncxx::v_noabi::stdx::string_view filename,
        std::istream* source,
        v_noabi::options::gridfs::upload const& options = {});

    MONGOCXX_ABI_EXPORT_CDECL(v_noabi::gridfs::downloader)
    open_download_stream(bsoncxx::v_noabi::types::view id);

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

    MONGOCXX_ABI_EXPORT_CDECL(void)
    download_to_stream(bsoncxx::v_noabi::types::view id, std::ostream* destination);

    MONGOCXX_ABI_EXPORT_CDECL(void)
    download_to_stream(bsoncxx::v_noabi::types::view id, std::ostream* destination, std::size_t start, std::size_t end);

    MONGOCXX_ABI_EXPORT_CDECL(void)
    download_to_stream(
        v_noabi::client_session const& session,
        bsoncxx::v_noabi::types::view id,
        std::ostream* destination);

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

    MONGOCXX_ABI_EXPORT_CDECL(void) delete_file(bsoncxx::v_noabi::types::view id);

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

    MONGOCXX_ABI_EXPORT_CDECL(v_noabi::cursor)
    find(bsoncxx::v_noabi::document::view_or_value filter, v_noabi::options::find const& options = {});

    MONGOCXX_ABI_EXPORT_CDECL(v_noabi::cursor)
    find(
        v_noabi::client_session const& session,
        bsoncxx::v_noabi::document::view_or_value filter,
        v_noabi::options::find const& options = {});

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::string_view) bucket_name() const;
};
 
} // namespace gridfs
} // namespace v_noabi
} // namespace mongocxx
 
namespace mongocxx {
namespace v_noabi {

inline v_noabi::gridfs::bucket from_v1(v1::gridfs::bucket v) {
    return {std::move(v)};
}

inline v1::gridfs::bucket to_v1(v_noabi::gridfs::bucket v) {
    return v1::gridfs::bucket{std::move(v)};
}
 
} // namespace v_noabi
} // namespace mongocxx
 
#include <mongocxx/config/postlude.hpp>