opendal.h File Reference

#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>

Go to the source code of this file.

Typedefs
typedef enum opendal_code	opendal_code
	The error code for all opendal APIs in C binding. More...
typedef struct BlockingLister	BlockingLister

Enumerations
enum	opendal_code {   OPENDAL_UNEXPECTED , OPENDAL_UNSUPPORTED , OPENDAL_CONFIG_INVALID , OPENDAL_NOT_FOUND ,   OPENDAL_PERMISSION_DENIED , OPENDAL_IS_A_DIRECTORY , OPENDAL_NOT_A_DIRECTORY , OPENDAL_ALREADY_EXISTS ,   OPENDAL_RATE_LIMITED , OPENDAL_IS_SAME_FILE }
	The error code for all opendal APIs in C binding. More...

Typedef Documentation

BlockingLister

typedef struct BlockingLister BlockingLister

BlockingLister is designed to list entries at given path in a blocking manner.

Users can construct Lister by [BlockingOperator::lister] or [BlockingOperator::lister_with].

• Lister implements Iterator<Item = Result<Entry>>.
• Lister will return None if there is no more entries or error has been returned.

opendal_code

typedef enum opendal_code opendal_code

The error code for all opendal APIs in C binding.

Todo:

The error handling is not complete, the error with error message will be added in the future.

Enumeration Type Documentation

opendal_code

enum opendal_code

The error code for all opendal APIs in C binding.

Todo:

The error handling is not complete, the error with error message will be added in the future.

Enumerator
OPENDAL_UNEXPECTED	returning it back. For example, s3 returns an internal service error.
OPENDAL_UNSUPPORTED	Underlying service doesn't support this operation.
OPENDAL_CONFIG_INVALID	The config for backend is invalid.
OPENDAL_NOT_FOUND	The given path is not found.
OPENDAL_PERMISSION_DENIED	The given path doesn't have enough permission for this operation
OPENDAL_IS_A_DIRECTORY	The given path is a directory.
OPENDAL_NOT_A_DIRECTORY	The given path is not a directory.
OPENDAL_ALREADY_EXISTS	The given path already exists thus we failed to the specified operation on it.
OPENDAL_RATE_LIMITED	Requests that sent to this path is over the limit, please slow down.
OPENDAL_IS_SAME_FILE	The given file paths are same.