rspx 0.1.0

Pixiv client writen in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

//! Pixiv API Rust Client
//!
//! This is a Rust client library for interacting with Pixiv API, providing authentication, network requests and other features.
//!
//! ## Features
//!
//! - OAuth2 password credential authentication
//! - Automatic token refresh
//! - Support for multiple runtimes (tokio/async-std/smol)
//! - Comprehensive error handling
//! - Detailed logging
//! - SNI bypass support (for bypassing network restrictions)
//!
//! ## Quick Start
//!
//! ```rust
//! use pixiv_rs::auth::AuthClient;
//!
//! #[tokio::main]
//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
//!     // Initialize logging
//!     tracing_subscriber::fmt::init();
//!
//!     // Create authentication client
//!     let mut auth_client = AuthClient::new()?;
//!
//!     // Login with username and password
//!     let auth_response = auth_client.login("your_username", "your_password").await?;
//!
//!     println!("Login successful! User ID: {}", auth_response.user.id);
//!
//!     Ok(())
//! }
//! ```

pub mod auth;
pub mod client {
    pub mod app;
    pub mod public;
    pub mod bypass_sni;
}
pub mod error;
pub mod models {
    pub mod app;
    pub mod public;
}
pub mod network;
pub mod utils;

// Re-export common types and functions
pub use auth::{AuthClient, AuthResponse, User as AuthUser};
pub use client::app::AppClient;
pub use client::public::PublicClient;
pub use client::bypass_sni::BypassSniAppClient;

/// Example of using SNI bypass feature
///
/// ```rust
/// use pixiv_rs::client::bypass_sni::BypassSniAppClient;
///
/// #[tokio::main]
/// async fn main() -> Result<(), Box<dyn std::error::Error>> {
///     // Use IP address to bypass SNI restrictions
///     let client = BypassSniAppClient::with_ip("210.140.131.145")?;
///
///     // Set access token
///     client.http_client.set_access_token("your_access_token".to_string());
///
///     // Call API
///     // let illust = client.illust_detail(12345).await?;
///
///     Ok(())
/// }
/// ```
pub use error::{ApiErrorCode, ApiErrorDetails, PixivError, Result};
pub use models::app::{
    Comment, CommentAccessControl, CommentsResponse, ContentType, Duration, Filter, FollowRestrict,
    Illust, IllustBookmarkResponse, IllustDetail, IllustFollowResponse, ImageUrls, MetaPage, MetaSinglePage,
    ProfileImageUrls, RankingLabel, RankingMode, RankingResponse, RecommendedResponse, RestrictionAttributes,
    SearchIllustResponse, SearchTarget, Series, Sort, Tag, TrendingTag, TrendingTagsResponse,
    UgoiraFrame, UgoiraMetadata, UgoiraMetadataResponse, User as AppUser, UserFollowerResponse,
    UserFollowingResponse, UserMypixivResponse, UserPreview, ZipUrls,
};
pub use models::public::{
    PublicIllust, PublicUser, PublicSearchResponse, PublicUserDetail, PublicUserIllusts, PublicUserBookmarks,
    PublicSearchResponse as PublicSearchIllustResponse, SearchTarget as PublicSearchTarget, Sort as PublicSort,
    Restrict as PublicRestrict, ContentType as PublicContentType, Duration as PublicDuration, Filter as PublicFilter
};
pub use network::HttpClient;
pub use utils::{download, extract_extension, format_file_size, parse_qs, safe_filename, set_accept_language};

/// Library version information
pub const VERSION: &str = env!("CARGO_PKG_VERSION");

/// Library name
pub const NAME: &str = env!("CARGO_PKG_NAME");

/// Initialize logger
///
/// This is a convenience function for initializing the default logger.
/// In production environments, you may need to configure more complex logging settings.
pub fn init_logging() {
    #[cfg(feature = "tracing-subscriber")]
    {
        use tracing_subscriber::{fmt, EnvFilter};
        
        fmt()
            .with_env_filter(EnvFilter::from_default_env())
            .init();
    }
    
    #[cfg(not(feature = "tracing-subscriber"))]
    {
        // If tracing-subscriber is not enabled, do not initialize logger
        // Users need to configure the logger themselves
        eprintln!("Warning: tracing-subscriber feature not enabled, logs may not be displayed");
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_library_info() {
        assert!(!VERSION.is_empty());
        assert_eq!(NAME, "pixiv_rs");
    }
}