Struct opendal::services::Icloud

pub struct Icloud {
    pub config: IcloudConfig,
    pub http_client: Option<HttpClient>,
}

Available on crate feature services-icloud only.

IcloudDrive service support.

Capabilities

This service can be used to:

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

Configuration

• root: Set the work directory for backend

Credentials related

provide Session (Temporary)

• trust_token: set the trust_token for icloud drive api Please notice its expiration.
• ds_web_auth_token: set the ds_web_auth_token for icloud drive api Get web trust the session.
• is_china_mainland: set the is_china_mainland for icloud drive api China region must true to use “https://www.icloud.com.cn” Otherwise Apple server will return 302. More information you can get apple.com

OpenDAL is a library, it cannot do the first step of OAuth2 for you. You need to get authorization code from user by calling icloudDrive’s authorize url and save it for session’s trust_token and session_token(ds_web_auth_token).

Make sure you have enabled Apple icloud Drive API in your Apple icloud ID. And your OAuth scope contains valid Session.

You can get more information from pyicloud or iCloud-API

You can refer to IcloudBuilder’s docs for more information

Example

Via Builder

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

#[tokio::main]
async fn main() -> Result<()> {
    let mut builder = Icloud::default();
    builder.root("/");
    builder.apple_id("<apple_id>");
    builder.password("<password>");
    builder.trust_token("<trust_token>");
    builder.ds_web_auth_token("<ds_web_auth_token>");
    builder.is_china_mainland(true);

    Ok(())
}

Fields

config: IcloudConfig

icloud config for web session request

http_client: Option<HttpClient>

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.

Implementations

impl IcloudBuilder

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

Set root of this backend.

All operations will happen under this root.

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

Your Apple id

It is required. your Apple login email, e.g. example@gmail.com

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

Your Apple id password

It is required. your icloud login password, e.g. password

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

Trust token and ds_web_auth_token is used for temporary access to the icloudDrive API.

Authenticate using session token

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

ds_web_auth_token must be set in Session

Avoid Two Factor Authentication

pub fn is_china_mainland(&mut self, is_china_mainland: bool) -> &mut Self

Set if your apple id in China mainland.

If in china mainland, we will connect to https://www.icloud.com.cn. Otherwise, we will connect to https://www.icloud.com.

pub fn http_client(&mut self, 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 IcloudBuilder

const SCHEME: Scheme = Scheme::Icloud

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

type Accessor = IcloudBackend

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 IcloudBuilder

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

Formats the value using the given formatter.

impl Default for IcloudBuilder

fn default() -> IcloudBuilder

Returns the “default value” for a type.