Rongcloud Rust SDK

融云（RongCloud）IM 服务端 API 的 Rust 实现。

✨ 特性

• 🦀 纯 Rust 实现 - 高性能、内存安全的异步 API 客户端
• 🌍 多地域支持 - 支持北京、新加坡、北美等多个数据中心节点
• 📦 丰富的消息类型 - 文本、图片、语音、文件、通知等多种内置消息类型
• 🔐 完整的用户管理 - 注册、封禁、黑名单、白名单等完整用户功能
• 💬 多会话类型 - 单聊、群聊、聊天室、系统通知全覆盖
• 🚀 异步优先 - 基于 Tokio 的全异步设计

📦 安装

将以下内容添加到你的 Cargo.toml 文件中：

[dependencies]
rongcloud = { git = "https://github.com/your-username/rongcloud-rust-sdk" }

🚀 快速开始

use rongcloud::{RongCloud, RongCloudConfig, Region};

#[tokio::main]
async fn main() {
    // 创建配置
    let config = RongCloudConfig::new("your_app_key", "your_app_secret")
        .with_region(Region::Beijing);

    // 创建客户端
    let client = RongCloud::new(config);

    // 注册用户并获取 Token
    let result = client.user_register("user_001", "张三", "https://example.com/avatar.jpg").await;

    match result {
        Ok(response) => {
            println!("用户 Token: {}", response.data.token);
        }
        Err(e) => {
            eprintln!("注册失败: {:?}", e);
        }
    }
}

📚 功能模块

用户管理

黑白名单管理

消息发送

use rongcloud::api::message::{PrivateMessage, GroupMessage, SystemMessage};
use rongcloud::messages::TextMessage;

// 发送单聊消息
let text = TextMessage::new("Hello World!", "附加内容");
let msg = PrivateMessage::new("sender_id", text.object_name(), text.to_json())
    .to_user("receiver_id")
    .push_content("你收到了一条新消息");

client.send_private_message(&msg).await?;

// 发送群聊消息
let group_msg = GroupMessage::new("sender_id", "RC:TxtMsg", content)
    .to_group("group_id")
    .is_mentioned(1);  // @所有人

client.send_group_message(&group_msg).await?;

// 发送系统通知
let sys_msg = SystemMessage::new("system", "RC:TxtMsg", content)
    .to_user("user_id");

client.send_system_message(&sys_msg).await?;

群组管理

聊天室管理

好友管理

敏感词管理

📱 消息类型

SDK 内置多种标准消息类型：

自定义消息

use serde::Serialize;

#[derive(Serialize)]
struct CustomMessage {
    #[serde(rename = "type")]
    msg_type: String,
    data: String,
}

impl CustomMessage {
    fn object_name() -> &'static str {
        "App:CustomMsg"
    }
}

🌍 多地域配置

use rongcloud::{RongCloudConfig, Region};

// 北京节点（默认）
let config = RongCloudConfig::new("app_key", "app_secret")
    .with_region(Region::Beijing);

// 新加坡节点
let config = RongCloudConfig::new("app_key", "app_secret")
    .with_region(Region::Singapore);

// 北美节点
let config = RongCloudConfig::new("app_key", "app_secret")
    .with_region(Region::NorthAmerica);

⚠️ 错误处理

use rongcloud::RongCloudError;

match client.user_register("user_id", "name", "avatar_url").await {
    Ok(response) => {
        if response.code == 200 {
            println!("成功: {:?}", response.data);
        } else {
            println!("业务错误码: {}", response.code);
        }
    }
    Err(RongCloudError::RequestFailed(msg)) => {
        eprintln!("请求失败: {}", msg);
    }
    Err(RongCloudError::SerializationError(e)) => {
        eprintln!("序列化错误: {}", e);
    }
    Err(e) => {
        eprintln!("其他错误: {:?}", e);
    }
}

🔧 配置项

🛠️ 开发

# 运行测试
cargo test

# 检查代码
cargo clippy

# 格式化
cargo fmt

📄 许可证

本项目采用 MIT 许可证 - 详见 LICENSE 文件。

🔗 相关链接

• 融云官方文档
• 融云开发者平台

📊 API 覆盖率

本 SDK 覆盖了融云服务端 API 的主要功能，包括：

• ✅ 用户管理服务
• ✅ 用户黑/白名单服务
• ✅ 好友管理（信息托管）
• ✅ 消息管理
• ✅ 群组管理
• ✅ 群组禁言服务
• ✅ 聊天室管理
• ✅ 内容审核（敏感词）
• ✅ 推送服务

更多 API 正在持续开发中...