cloudreve_api/
lib.rs

1//! A Rust library for interacting with Cloudreve API
2//!
3//! This library provides asynchronous access to the Cloudreve API endpoints.
4//! It handles authentication, request building, and response parsing.
5//!
6//! # Examples
7//!
8//! ## Using CloudreveAPI (recommended)
9//!
10//! ```no_run
11//! use cloudreve_api::{CloudreveAPI, Result};
12//!
13//! #[tokio::main]
14//! async fn main() -> Result<()> {
15//!     // Auto-detect version
16//!     let mut api = CloudreveAPI::new("https://your-cloudreve-instance.com").await?;
17//!
18//!     // Login
19//!     api.login("user@example.com", "password").await?;
20//!
21//!     // List files
22//!     let files = api.list_files("/", None, None).await?;
23//!     println!("Found {} items", files.total_count());
24//!
25//!     Ok(())
26//! }
27//! ```
28
29pub mod api;
30pub mod client;
31pub mod cloudreve_api;
32pub mod error;
33
34pub use api::v3::models::{
35    ApiResponse, Aria2CreateRequest, Aria2Task, CopyObjectRequest, CreateDirectoryRequest,
36    CreateFileRequest, DeleteObjectRequest, DirectoryList, DownloadUrl, FileSource,
37    FileSourceRequest, LoginRequest, MoveObjectRequest, Object, OtpLoginRequest, Policy, Property,
38    RenameObjectRequest, Share, ShareRequest, SiteConfig, SourceItems, StorageInfo,
39    UploadFileRequest, UploadSession, User, UserGroup, WebdavAccount,
40};
41pub use api::v4::models::*;
42
43// Main Cloudreve API client
44pub use cloudreve_api::{
45    CloudreveAPI, DeleteTarget, FileInfo, FileItem, FileList, LoginResponse, TokenInfo, UserInfo,
46    V3LoginResponse, V4LoginResponse,
47};
48
49// Legacy exports for backward compatibility
50pub use api::v4::ApiV4Client as CloudreveClient;
51pub use client::UnifiedClient;
52
53// Re-export version-specific clients for advanced use cases
54pub use api::v3::ApiV3Client;
55pub use api::v4::ApiV4Client as ApiV4Client_;
56
57// Re-export API version types
58pub use api::{ApiVersion, VersionInfo};
59
60// Re-export error type
61pub use error::Error;
62
63/// A result type alias for convenience
64pub type Result<T> = std::result::Result<T, Error>;
65
66/// Cloudreve API library version
67pub const VERSION: &str = env!("CARGO_PKG_VERSION");
cloudreve_api/lib.rs

cloudreve_api/
lib.rs
