diff options
Diffstat (limited to 'src/mongo/base/concept/clonable.h')
-rw-r--r-- | src/mongo/base/concept/clonable.h | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/src/mongo/base/concept/clonable.h b/src/mongo/base/concept/clonable.h new file mode 100644 index 00000000000..71bd3590b33 --- /dev/null +++ b/src/mongo/base/concept/clonable.h @@ -0,0 +1,47 @@ +/*- + * Copyright (C) 2016 MongoDB Inc. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License, version 3, + * as published by the Free Software Foundation. + * + * 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 + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + * + * 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 GNU Affero General 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 "mongo/base/concept/constructible.h" +#include "mongo/base/concept/unique_ptr.h" + +namespace mongo { +namespace concept { +/*! + * Objects conforming to the Clonable concept can be dynamically copied, using `this->clone()`. + * The Clonable concept does not specify the return type of the `clone()` function. + */ +struct Clonable { + /*! Clonable objects must be safe to destroy, by pointer. */ + virtual ~Clonable() noexcept = 0; + + /*! Clonable objects can be cloned without knowing the actual dynamic type. */ + Constructible<UniquePtr<Clonable>> clone() const; +}; +} // namespace concept +} // namespace mongo |