opendal_async.hpp

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 <cstdint>
#include <optional>
#include <span>
#include <string>
#include <string_view>
#include <unordered_map>
 
#include "async.rs.h"
 
namespace opendal::async {
 
class Operator {
 public:
  Operator(std::string_view scheme,
           const std::unordered_map<std::string, std::string> &config = {});
 
  // Disable copy and assign
  Operator(const Operator &) = delete;
  Operator &operator=(const Operator &) = delete;
 
  // Enable move
  Operator(Operator &&) = default;
  Operator &operator=(Operator &&) = default;
  ~Operator() = default;
 
  using ReadFuture = opendal::ffi::async_op::RustFutureRead;
  ReadFuture Read(std::string_view path);
 
  using WriteFuture = opendal::ffi::async_op::RustFutureWrite;
  WriteFuture Write(std::string_view path, std::span<uint8_t> data);
 
  using ListFuture = opendal::ffi::async_op::RustFutureList;
  ListFuture List(std::string_view path);
 
  using ExistsFuture = opendal::ffi::async_op::RustFutureBool;
  ExistsFuture Exists(std::string_view path);
 
  using CreateDirFuture = opendal::ffi::async_op::RustFutureWrite;
  CreateDirFuture CreateDir(std::string_view path);
 
  using CopyFuture = opendal::ffi::async_op::RustFutureWrite;
  CopyFuture Copy(std::string_view from, std::string_view to);
 
  using RenameFuture = opendal::ffi::async_op::RustFutureWrite;
  RenameFuture Rename(std::string_view from, std::string_view to);
 
  using DeleteFuture = opendal::ffi::async_op::RustFutureWrite;
  DeleteFuture DeletePath(std::string_view path);
 
  using ReaderFuture = opendal::ffi::async_op::RustFutureReaderId;
  ReaderFuture GetReader(std::string_view path);
 
  using ListerFuture = opendal::ffi::async_op::RustFutureListerId;
  ListerFuture GetLister(std::string_view path);
 
 private:
  rust::Box<opendal::ffi::async_op::Operator> operator_;
};
 
class Reader {
 public:
  // Disable copy and assign
  Reader(const Reader &) = delete;
  Reader &operator=(const Reader &) = delete;
 
  // Enable move
  Reader(Reader &&other) noexcept;
  Reader &operator=(Reader &&other) noexcept;
  ~Reader() noexcept;
 
  // Constructor from ID (for tests and advanced usage)
  explicit Reader(size_t reader_id) noexcept;
 
  using ReadFuture = opendal::ffi::async_op::RustFutureRead;
 
  ReadFuture Read(uint64_t start, uint64_t len);
 
 private:
  friend class Operator;
 
  void Destroy() noexcept;
 
  size_t reader_id_{0};
};
 
class Lister {
 public:
  // Disable copy and assign
  Lister(const Lister &) = delete;
  Lister &operator=(const Lister &) = delete;
 
  // Enable move
  Lister(Lister &&other) noexcept;
  Lister &operator=(Lister &&other) noexcept;
  ~Lister() noexcept;
 
  // Constructor from ID (for tests and advanced usage)
  explicit Lister(size_t lister_id) noexcept;
 
  using NextFuture = opendal::ffi::async_op::RustFutureEntryOption;
 
  NextFuture Next();
 
 private:
  friend class Operator;
 
  void Destroy() noexcept;
 
  size_t lister_id_{0};
};
 
}  // namespace opendal::async