ceph/src/seastar/include/seastar/util/file.hh

   1 /*
   2  * This file is open source software, licensed to you under the terms
   3  * of the Apache License, Version 2.0 (the "License").  See the NOTICE file
   4  * distributed with this work for additional information regarding copyright
   5  * ownership.  You may not use this file except in compliance with the License.
   6  *
   7  * You may obtain a copy of the License at
   8  *
   9  *   http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing,
  12  * software distributed under the License is distributed on an
  13  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  14  * KIND, either express or implied.  See the License for the
  15  * specific language governing permissions and limitations
  16  * under the License.
  17  */
  18
  19 /*
  20  * Copyright 2020 ScyllaDB
  21  */
  22
  23 #pragma once
  24
  25 #include <seastar/core/future.hh>
  26 #include <seastar/util/std-compat.hh>
  27
  28 namespace seastar {
  29
  30 /// Recursively removes a directory and all of its contents.
  31 ///
  32 /// \param path path of the directory to recursively remove
  33 ///
  34 /// \note
  35 /// Unlike `rm -rf` path has to be a directory and may not refer to a regular file.
  36 ///
  37 /// The function flushes the parent directory of the removed path and so guaranteeing that
  38 /// the remove is stable on disk.
  39 ///
  40 /// The function bails out on first error. In that case, some files and/or sub-directories
  41 /// (and their contents) may be left behind at the level in which the error was detected.
  42 ///
  43 future<> recursive_remove_directory(std::filesystem::path path) noexcept;
  44
  45 } // namespace seastar