Skip to main content

Crate fishpi_sdk

Crate fishpi_sdk 

Source
Expand description

§摸鱼派 Rust SDK

这是一个用于与摸鱼派社区 API 交互的 Rust SDK,提供用户管理、文章、聊天室、私聊、通知、清风明月、红包、评论、举报、日志、文件上传等功能的异步客户端。

§主要组件

  • FishPi - 静态客户端,提供不需要认证的操作(如登录、注册、验证)。
  • api - API 客户端模块,包含各个子模块(如用户、文章等)。
  • model - 数据模型模块,定义请求和响应的数据结构。
  • utils - 工具模块,提供 HTTP 请求、错误处理等辅助功能。

§功能特性

  • 异步支持: 使用 tokio 提供异步 API 调用。
  • 类型安全: 使用 Serde 进行序列化/反序列化,确保数据类型安全。
  • 错误处理: 统一的错误类型和处理机制。
  • 文件上传: 支持多文件上传。

§示例

use fishpi_sdk::{FishPi, model::misc::LoginData};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let login_data = LoginData::new("your_name_or_email", "your_password", None);
    let user = FishPi::login(&login_data).await?;
    let points = user.get_points("target_user").await?;
    println!("{}: {}", points.name, points.point);
    Ok(())
}

Modules§

api
model
utils

Macros§

impl_str_enum

Structs§

FishPi
摸鱼派 Rust SDK 接口