Struct opendal::services::Dropbox

pub struct Dropbox { /* private fields */ }

Available on crate feature services-dropbox only.

Dropbox backend support.

Capabilities

This service can be used to:

• stat
• read
• write
• create_dir
• delete
• copy
• rename
• list
• batch
• blocking

Configuration

• root: Set the work directory for this backend.

Credentials related

Just provide Access Token (Temporary)

• access_token: set the access_token for this backend. Please notice its expiration.

Or provide Client ID and Client Secret and refresh token (Long Term)

If you want to let OpenDAL to refresh the access token automatically, please provide the following fields:

• refresh_token: set the refresh_token for dropbox api
• client_id: set the client_id for dropbox api
• client_secret: set the client_secret for dropbox api

OpenDAL is a library, it cannot do the first step of OAuth2 for you. You need to get authorization code from user by calling Dropbox’s authorize url and exchange it for refresh token.

Please refer to Dropbox OAuth2 Guide for more information.

You can refer to DropboxBuilder’s docs for more information

Example

Via Builder

use anyhow::Result;
use opendal::raw::OpWrite;
use opendal::services::Dropbox;
use opendal::Operator;

#[tokio::main]
async fn main() -> Result<()> {
    let mut builder = Dropbox::default();
    builder.root("/opendal");
    builder.access_token("<token>");

    let op: Operator = Operator::new(builder)?.finish();
    Ok(())
}

Implementations

impl DropboxBuilder

pub fn root(&mut self, root: &str) -> &mut Self

Set the root directory for dropbox.

Default to / if not set.

pub fn access_token(&mut self, access_token: &str) -> &mut Self

Access token is used for temporary access to the Dropbox API.

You can get the access token from Dropbox App Console

NOTE: this token will be expired in 4 hours. If you are trying to use the Dropbox service in a long time, please set a refresh_token instead.

pub fn refresh_token(&mut self, refresh_token: &str) -> &mut Self

Refresh token is used for long term access to the Dropbox API.

You can get the refresh token via OAuth 2.0 Flow of Dropbox.

OpenDAL will use this refresh token to get a new access token when the old one is expired.

pub fn client_id(&mut self, client_id: &str) -> &mut Self

Set the client id for Dropbox.

This is required for OAuth 2.0 Flow to refresh the access token.

pub fn client_secret(&mut self, client_secret: &str) -> &mut Self

Set the client secret for Dropbox.

This is required for OAuth 2.0 Flow with refresh the access token.

pub fn http_client(&mut self, http_client: HttpClient) -> &mut Self

Specify the http client that used by this service.

Notes

This API is part of OpenDAL’s Raw API. HttpClient could be changed during minor updates.

Trait Implementations

impl Builder for DropboxBuilder

const SCHEME: Scheme = Scheme::Dropbox

Associated scheme for this builder. It indicates what underlying service is.

type Accessor = DropboxBackend

The accessor that built by this builder.

fn from_map(map: HashMap<String, String>) -> Self

Construct a builder from given map which contains several parameters needed by underlying service.

fn build(&mut self) -> Result<Self::Accessor>

Consume the accessor builder to build a service.

impl Debug for DropboxBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DropboxBuilder

fn default() -> DropboxBuilder

Returns the “default value” for a type.