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 <istream>
#include <memory>
#include <ostream>
 
#include <mongocxx/database-fwd.hpp>
#include <mongocxx/gridfs/bucket-fwd.hpp>
 
#include <bsoncxx/document/view_or_value.hpp>
#include <bsoncxx/stdx/optional.hpp>
#include <bsoncxx/stdx/string_view.hpp>
#include <bsoncxx/types/bson_value/view.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>
#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 {
   public:
    MONGOCXX_ABI_EXPORT_CDECL() bucket() noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL() bucket(bucket&&) noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL(bucket&) operator=(bucket&&) noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL() bucket(const bucket&);
 
    MONGOCXX_ABI_EXPORT_CDECL(bucket&) operator=(const bucket&);
 
    MONGOCXX_ABI_EXPORT_CDECL() ~bucket();
 
    explicit MONGOCXX_ABI_EXPORT_CDECL() operator bool() const noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL(uploader)
    open_upload_stream(bsoncxx::v_noabi::stdx::string_view filename,
                       const options::gridfs::upload& options = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(uploader)
    open_upload_stream(const client_session& session,
                       bsoncxx::v_noabi::stdx::string_view filename,
                       const options::gridfs::upload& options = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(uploader)
    open_upload_stream_with_id(bsoncxx::v_noabi::types::bson_value::view id,
                               bsoncxx::v_noabi::stdx::string_view filename,
                               const options::gridfs::upload& options = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(uploader)
    open_upload_stream_with_id(const client_session& session,
                               bsoncxx::v_noabi::types::bson_value::view id,
                               bsoncxx::v_noabi::stdx::string_view filename,
                               const options::gridfs::upload& options = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(result::gridfs::upload)
    upload_from_stream(bsoncxx::v_noabi::stdx::string_view filename,
                       std::istream* source,
                       const options::gridfs::upload& options = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(result::gridfs::upload)
    upload_from_stream(const client_session& session,
                       bsoncxx::v_noabi::stdx::string_view filename,
                       std::istream* source,
                       const options::gridfs::upload& options = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(void)
    upload_from_stream_with_id(bsoncxx::v_noabi::types::bson_value::view id,
                               bsoncxx::v_noabi::stdx::string_view filename,
                               std::istream* source,
                               const options::gridfs::upload& options = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(void)
    upload_from_stream_with_id(const client_session& session,
                               bsoncxx::v_noabi::types::bson_value::view id,
                               bsoncxx::v_noabi::stdx::string_view filename,
                               std::istream* source,
                               const options::gridfs::upload& options = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(downloader)
    open_download_stream(bsoncxx::v_noabi::types::bson_value::view id);
 
    MONGOCXX_ABI_EXPORT_CDECL(downloader)
    open_download_stream(const client_session& session,
                         bsoncxx::v_noabi::types::bson_value::view id);
 
    MONGOCXX_ABI_EXPORT_CDECL(void)
    download_to_stream(bsoncxx::v_noabi::types::bson_value::view id, std::ostream* destination);
 
    MONGOCXX_ABI_EXPORT_CDECL(void)
    download_to_stream(bsoncxx::v_noabi::types::bson_value::view id,
                       std::ostream* destination,
                       std::size_t start,
                       std::size_t end);
 
    MONGOCXX_ABI_EXPORT_CDECL(void)
    download_to_stream(const client_session& session,
                       bsoncxx::v_noabi::types::bson_value::view id,
                       std::ostream* destination);
 
    MONGOCXX_ABI_EXPORT_CDECL(void)
    download_to_stream(const client_session& session,
                       bsoncxx::v_noabi::types::bson_value::view id,
                       std::ostream* destination,
                       std::size_t start,
                       std::size_t end);
 
    MONGOCXX_ABI_EXPORT_CDECL(void) delete_file(bsoncxx::v_noabi::types::bson_value::view id);
 
    MONGOCXX_ABI_EXPORT_CDECL(void)
    delete_file(const client_session& session, bsoncxx::v_noabi::types::bson_value::view id);
 
    MONGOCXX_ABI_EXPORT_CDECL(cursor)
    find(bsoncxx::v_noabi::document::view_or_value filter, const options::find& options = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(cursor)
    find(const client_session& session,
         bsoncxx::v_noabi::document::view_or_value filter,
         const options::find& options = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::string_view) bucket_name() const;
 
   private:
    friend ::mongocxx::v_noabi::database;
 
    // Constructs a new GridFS bucket.  Throws if options are invalid.
    bucket(const database& db, const options::gridfs::bucket& options);
 
    void create_indexes_if_nonexistent(const client_session* session);
 
    uploader _open_upload_stream_with_id(const client_session* session,
                                         bsoncxx::v_noabi::types::bson_value::view id,
                                         bsoncxx::v_noabi::stdx::string_view filename,
                                         const options::gridfs::upload& options);
 
    void _upload_from_stream_with_id(const client_session* session,
                                     bsoncxx::v_noabi::types::bson_value::view id,
                                     bsoncxx::v_noabi::stdx::string_view filename,
                                     std::istream* source,
                                     const options::gridfs::upload& options);
 
    downloader _open_download_stream(const client_session* session,
                                     bsoncxx::v_noabi::types::bson_value::view id,
                                     bsoncxx::v_noabi::stdx::optional<std::size_t> start,
                                     bsoncxx::v_noabi::stdx::optional<std::size_t> end);
 
    void _download_to_stream(const client_session* session,
                             bsoncxx::v_noabi::types::bson_value::view id,
                             std::ostream* destination,
                             bsoncxx::v_noabi::stdx::optional<std::size_t> start,
                             bsoncxx::v_noabi::stdx::optional<std::size_t> end);
 
    void _delete_file(const client_session* session, bsoncxx::v_noabi::types::bson_value::view id);
 
    class impl;
 
    impl& _get_impl();
    const impl& _get_impl() const;
 
    std::unique_ptr<impl> _impl;
};
 
}  // namespace gridfs
}  // namespace v_noabi
}  // namespace mongocxx
 
#include <mongocxx/config/postlude.hpp>