summaryrefslogtreecommitdiff
path: root/src/mongo/db/sorter/file.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/mongo/db/sorter/file.h')
-rw-r--r--src/mongo/db/sorter/file.h94
1 files changed, 0 insertions, 94 deletions
diff --git a/src/mongo/db/sorter/file.h b/src/mongo/db/sorter/file.h
deleted file mode 100644
index e47bf353bef..00000000000
--- a/src/mongo/db/sorter/file.h
+++ /dev/null
@@ -1,94 +0,0 @@
-/**
- * Copyright (C) 2021-present MongoDB, Inc.
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the Server Side Public License, version 1,
- * as published by MongoDB, Inc.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * Server Side Public License for more details.
- *
- * You should have received a copy of the Server Side Public License
- * along with this program. If not, see
- * <http://www.mongodb.com/licensing/server-side-public-license>.
- *
- * As a special exception, the copyright holders give permission to link the
- * code of portions of this program with the OpenSSL library under certain
- * conditions as described in each individual source file and distribute
- * linked combinations including the program with the OpenSSL library. You
- * must comply with the Server Side Public License in all respects for
- * all of the code used other than as permitted herein. If you modify file(s)
- * with this exception, you may extend this exception to your version of the
- * file(s), but you are not obligated to do so. If you do not wish to do so,
- * delete this exception statement from your version. If you delete this
- * exception statement from all source files in the program, then also delete
- * it in the license file.
- */
-
-#pragma once
-
-#include <boost/filesystem/path.hpp>
-#include <fstream>
-#include <string>
-#include <utility>
-
-#include "mongo/util/assert_util.h"
-
-namespace mongo::sorter {
-/**
- * Represents the file that a Sorter uses to spill to disk. Supports reading after writing (or
- * reading without any writing), but does not support writing after any reading has been done.
- */
-class File {
-public:
- File(std::string path) : _path(std::move(path)) {
- invariant(!_path.empty());
- }
-
- ~File();
-
- const boost::filesystem::path& path() const {
- return _path;
- }
-
- /**
- * Signals that the on-disk file should not be cleaned up.
- */
- void keep() {
- _keep = true;
- };
-
- /**
- * Reads the requested data from the file. Cannot write more to the file once this has been
- * called.
- */
- void read(std::streamoff offset, std::streamsize size, void* out);
-
- /**
- * Writes the given data to the end of the file. Cannot be called after reading.
- */
- void write(const char* data, std::streamsize size);
-
- /**
- * Returns the current offset of the end of the file. Cannot be called after reading.
- */
- std::streamoff currentOffset();
-
-private:
- void _open();
-
- void _ensureOpenForWriting();
-
- boost::filesystem::path _path;
- std::fstream _file;
-
- // The current offset of the end of the file, or -1 if the file either has not yet been
- // opened or is already being read.
- std::streamoff _offset = -1;
-
- // Whether to keep the on-disk file even after this in-memory object has been destructed.
- bool _keep = false;
-};
-} // namespace mongo::sorter