pub struct Onedrive { /* private fields */ }
services-onedrive
only.Expand description
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 APIclient_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 applicationroot
: Set the work directory for OneDrive backendenable_versioning
: Enable versioning support for OneDrive items
The configuration for tokens is one of the following:
access_token
only, for short-lived access. Once theaccess_token
expires, you must recreate the operator with a new token.refresh_token
,client_id
, and an optionalclient_secret
, for long-lived access. The operator will automatically get and refresh the access token.
§How to get tokens
- Create an application: navigate to Microsoft Entra Admin Center -> Applications -> App Registrations -> New registration
- In “Supported account types”, choose “Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox)”
- Or in an existing application -> manifest, make sure
signInAudience
is"AzureADandPersonalMicrosoftAccount"
. That’s because we’re calling Graph API with/common
path segment. - The platform you choose determines whether you have to provide a
client_secret
or not. See Public and confidential client apps for more information.- In short, if you choose “Mobile and desktop applications” or “Single-page application” (Public Client), you must not provide
client_secret
. - If you choose “Web” (Confidential Client), create a secret in “Certificates & secrets -> Client secrets -> New client secret”, and provide it as
client_secret
.
- In short, if you choose “Mobile and desktop applications” or “Single-page application” (Public Client), you must not provide
- 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. - If you need
refresh_token
for long-lived access, add an additionaloffline_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§
Source§impl OnedriveBuilder
impl OnedriveBuilder
Sourcepub fn http_client(self, http_client: HttpClient) -> Self
👎Deprecated since 0.53.0: Use Operator::update_http_client
instead
pub fn http_client(self, http_client: HttpClient) -> Self
Operator::update_http_client
insteadSpecify 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.
Sourcepub fn access_token(self, access_token: &str) -> Self
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.
Sourcepub fn refresh_token(self, refresh_token: &str) -> Self
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
.
Sourcepub fn client_id(self, client_id: &str) -> Self
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.
Sourcepub fn client_secret(self, client_secret: &str) -> Self
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.
Sourcepub fn enable_versioning(self, enabled: bool) -> Self
pub fn enable_versioning(self, enabled: bool) -> Self
Enable versioning support for OneDrive
Trait Implementations§
Source§impl Builder for OnedriveBuilder
impl Builder for OnedriveBuilder
Source§impl Debug for OnedriveBuilder
impl Debug for OnedriveBuilder
Source§impl Default for OnedriveBuilder
impl Default for OnedriveBuilder
Source§fn default() -> OnedriveBuilder
fn default() -> OnedriveBuilder
Auto Trait Implementations§
impl Freeze for OnedriveBuilder
impl !RefUnwindSafe for OnedriveBuilder
impl Send for OnedriveBuilder
impl Sync for OnedriveBuilder
impl Unpin for OnedriveBuilder
impl !UnwindSafe for OnedriveBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> CompatExt for T
impl<T> CompatExt for T
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request
Source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.