Struct opendal::services::Onedrive

pub struct Onedrive { /* private fields */ }

Available on crate feature services-onedrive only.

Microsoft OneDrive backend support.

Capabilities

This service can be used to:

• stat
• read
• write
• append
• create_dir
• delete
• copy
• rename
• list
• presign
• blocking

Notes

Currently, OpenDAL supports OneDrive Personal only.

Write Operations and OneDrive Behavior

For write-related operations, such as:

• write
• rename
• copy
• create_dir

OpenDAL’s OneDrive service replaces the destination folder instead of rename it.

Consistency Issues with Concurrent Requests

OneDrive does not guarantee consistency when handling a large number of concurrent requests write operations.

In some extreme cases, OneDrive may acknowledge an operation as successful but fail to commit the changes. This inconsistency can cause subsequent operations to fail, returning errors like:

• 400 Bad Request: OneDrive considers folders in the path are not there yet
• 404 Not Found: OneDrive doesn’t recognize the created folder
• 409 Conflict: OneDrive can’t replace an existing folder

You should consider [RetryLayer] and monitor your operations carefully.

Configuration

• access_token: Set a short-live access token for Microsoft Graph API (also, OneDrive API)
• refresh_token: Set a long term access token for Microsoft Graph API
• client_id: Set the client ID for a Microsoft Graph API application (available though Azure’s registration portal)
• client_secret: Set the client secret for a Microsoft Graph API application
• root: Set the work directory for OneDrive backend
• enable_versioning: Enable versioning support for OneDrive items

The configuration for tokens is one of the following:

• access_token only, for short-lived access. Once the access_token expires, you must recreate the operator with a new token.
• refresh_token, client_id, and an optional client_secret, for long-lived access. The operator will automatically get and refresh the access token.

How to get tokens

1. Create an application: navigate to Microsoft Entra Admin Center -> Applications -> App Registrations -> New registration
2. In “Supported account types”, choose “Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox)”
3. Or in an existing application -> manifest, make sure signInAudience is "AzureADandPersonalMicrosoftAccount". That’s because we’re calling Graph API with /common path segment.
4. The platform you choose determines whether you have to provide a client_secret or not. See Public and confidential client apps for more information.
   1. In short, if you choose “Mobile and desktop applications” or “Single-page application” (Public Client), you must not provide client_secret.
   2. If you choose “Web” (Confidential Client), create a secret in “Certificates & secrets -> Client secrets -> New client secret”, and provide it as client_secret.
5. Follow the code grant flow or other flows to get the access_token. The minimum scope is Files.ReadWrite. And make sure the access token represents a user, because it’s accessing the user’s onedrive by /me/drive. So “client credentials flow” won’t work.
6. If you need refresh_token for long-lived access, add an additional offline_access scope.

Read more at OnedriveBuilder.

Example

Via Builder

When you have a current access token:

use anyhow::Result;
use opendal::services::Onedrive;
use opendal::Operator;

#[tokio::main]
async fn main() -> Result<()> {
    // create backend builder
    let mut builder = Onedrive::default()
        .access_token("my_access_token")
        .root("/root/folder/for/operator");

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

When you have an Application with a refresh token:

use anyhow::Result;
use opendal::services::Onedrive;
use opendal::Operator;

#[tokio::main]
async fn main() -> Result<()> {
    // create backend builder
    let mut builder = Onedrive::default()
        .refresh_token("my_refresh_token")
        .client_id("my_client_id")
        .root("/root/folder/for/operator");

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

Implementations

impl OnedriveBuilder

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

Set root path of OneDrive folder.

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

👎Deprecated since 0.53.0: Use Operator::update_http_client instead

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.

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

Set the access token for a time limited access to Microsoft Graph API (also OneDrive).

Microsoft Graph API uses a typical OAuth 2.0 flow for authentication and authorization. You can get a access token from Microsoft Graph Explore.

Note

• An access token is short-lived.
• Use a refresh_token if you want to use OneDrive API for an extended period of time.

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

Set the refresh token for long term access to Microsoft Graph API.

OpenDAL will use a refresh token to maintain a fresh access token automatically.

Note

• A refresh token is available through a OAuth 2.0 flow, with an additional scope offline_access.

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

Set the client_id for a Microsoft Graph API application (available though Azure’s registration portal)

Required when using the refresh token.

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

Set the client_secret for a Microsoft Graph API application

Required for Web app when using the refresh token. Don’t use a client secret when use in a native app since the native app can’t store the secret reliably.

pub fn enable_versioning(self, enabled: bool) -> Self

Enable versioning support for OneDrive

Trait Implementations

impl Builder for OnedriveBuilder

const SCHEME: Scheme = Scheme::Onedrive

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

type Config = OnedriveConfig

Associated configuration for this builder.

fn build(self) -> Result<impl Access>

Consume the accessor builder to build a service.

impl Debug for OnedriveBuilder

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

Formats the value using the given formatter.

impl Default for OnedriveBuilder

fn default() -> OnedriveBuilder

Returns the “default value” for a type.