Operator is the entry for all public APIs.
More...
#include <opendal.hpp>
|
| Operator () noexcept |
|
| Operator (std::string_view scheme, const std::unordered_map< std::string, std::string > &config={}) |
| Construct a new Operator object.
|
|
| Operator (const Operator &)=delete |
|
Operator & | operator= (const Operator &)=delete |
|
| Operator (Operator &&other) noexcept |
|
Operator & | operator= (Operator &&other) noexcept |
|
| ~Operator () noexcept |
|
bool | Available () const |
| Check if the operator is available.
|
|
std::string | Read (std::string_view path) |
| Read data from the operator.
|
|
void | Write (std::string_view path, std::string_view data) |
| Write data to the operator.
|
|
Reader | GetReader (std::string_view path) |
| Read data from the operator.
|
|
bool | IsExist (std::string_view path) |
| Check if the path exists.
|
|
bool | Exists (std::string_view path) |
| Check if the path exists.
|
|
void | CreateDir (std::string_view path) |
| Create a directory.
|
|
void | Copy (std::string_view src, std::string_view dst) |
| Copy a file from src to dst.
|
|
void | Rename (std::string_view src, std::string_view dst) |
| Rename a file from src to dst.
|
|
void | Remove (std::string_view path) |
| Remove a file or directory.
|
|
Metadata | Stat (std::string_view path) |
| Get the metadata of a file or directory.
|
|
std::vector< Entry > | List (std::string_view path) |
| List the entries of a directory.
|
|
Lister | GetLister (std::string_view path) |
|
Capability | Info () |
|
Operator is the entry for all public APIs.
◆ Operator() [1/4]
opendal::Operator::Operator |
( |
| ) |
|
|
noexcept |
◆ Operator() [2/4]
opendal::Operator::Operator |
( |
std::string_view |
scheme, |
|
|
const std::unordered_map< std::string, std::string > & |
config = {} |
|
) |
| |
Construct a new Operator object.
- Parameters
-
scheme | The scheme of the operator, same as the name of rust doc |
config | The configuration of the operator, same as the service doc |
◆ Operator() [3/4]
opendal::Operator::Operator |
( |
const Operator & |
| ) |
|
|
delete |
◆ Operator() [4/4]
opendal::Operator::Operator |
( |
Operator && |
other | ) |
|
|
noexcept |
◆ ~Operator()
opendal::Operator::~Operator |
( |
| ) |
|
|
noexcept |
◆ Available()
bool opendal::Operator::Available |
( |
| ) |
const |
Check if the operator is available.
- Returns
- true if the operator is available, false otherwise
◆ Copy()
void opendal::Operator::Copy |
( |
std::string_view |
src, |
|
|
std::string_view |
dst |
|
) |
| |
Copy a file from src to dst.
- Parameters
-
src | The source path |
dst | The destination path |
◆ CreateDir()
void opendal::Operator::CreateDir |
( |
std::string_view |
path | ) |
|
Create a directory.
- Parameters
-
path | The path of the directory |
◆ Exists()
bool opendal::Operator::Exists |
( |
std::string_view |
path | ) |
|
Check if the path exists.
- Parameters
-
- Returns
- true if the path exists, false otherwise
◆ GetLister()
Lister opendal::Operator::GetLister |
( |
std::string_view |
path | ) |
|
◆ GetReader()
Reader opendal::Operator::GetReader |
( |
std::string_view |
path | ) |
|
Read data from the operator.
- Parameters
-
- Returns
- The reader of the data
◆ Info()
◆ IsExist()
bool opendal::Operator::IsExist |
( |
std::string_view |
path | ) |
|
Check if the path exists.
- Parameters
-
- Returns
- true if the path exists, false otherwise
◆ List()
std::vector< Entry > opendal::Operator::List |
( |
std::string_view |
path | ) |
|
List the entries of a directory.
- Note
- The returned entries are sorted by name.
- Parameters
-
path | The path of the directory |
- Returns
- The entries of the directory
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ Read()
std::string opendal::Operator::Read |
( |
std::string_view |
path | ) |
|
Read data from the operator.
- Note
- The operation will make unnecessary copy. So we recommend to use the
GetReader
method.
- Parameters
-
- Returns
- The data read from the operator
◆ Remove()
void opendal::Operator::Remove |
( |
std::string_view |
path | ) |
|
Remove a file or directory.
- Parameters
-
path | The path of the file or directory |
◆ Rename()
void opendal::Operator::Rename |
( |
std::string_view |
src, |
|
|
std::string_view |
dst |
|
) |
| |
Rename a file from src to dst.
- Parameters
-
src | The source path |
dst | The destination path |
◆ Stat()
Metadata opendal::Operator::Stat |
( |
std::string_view |
path | ) |
|
Get the metadata of a file or directory.
- Parameters
-
path | The path of the file or directory |
- Returns
- The metadata of the file or directory
◆ Write()
void opendal::Operator::Write |
( |
std::string_view |
path, |
|
|
std::string_view |
data |
|
) |
| |
Write data to the operator.
- Parameters
-
path | The path of the data |
data | The data to write |
The documentation for this class was generated from the following file:
- /home/runner/work/opendal/opendal/bindings/cpp/include/opendal.hpp