9 个稳定版本

1.3.2 2024年2月9日
1.3.1 2023年10月21日
1.3.0 2023年7月11日
1.2.2 2023年6月10日
1.0.3 2022年12月29日

#2 in #social

Download history 24/week @ 2024-04-22 16/week @ 2024-04-29 4/week @ 2024-05-06 37/week @ 2024-05-20 4/week @ 2024-05-27 15/week @ 2024-06-03 9/week @ 2024-06-10 28/week @ 2024-06-17 12/week @ 2024-06-24 12/week @ 2024-07-01 4/week @ 2024-07-15 96/week @ 2024-07-29 7/week @ 2024-08-05

107 每月下载次数
3 crates 中使用

MIT/Apache

250KB
5.5K SLoC

异步 Mastodon 客户端库

[Build Status] crates.io Docs MIT/APACHE-2.0

文档

Mastodon 客户端 API 提供一个类型安全的异步包装器

安装

要将 mastodon-async 添加到您的项目中,请将以下内容添加到 Cargo.toml[dependencies] 部分

mastodon-async = "1.0"

或者,运行以下命令

$ cargo add mastodon-async

使用 Rustls 替代 OpenSSL

要使用 Rustls 而不是 OpenSSL 进行 HTTPS 请求,请按照以下方式定义依赖关系

mastodon-async = { version = "1", default-features = false, features = ["rustls-tls"] }

关于调试的说明

此库提供结构化日志记录。为了更好地了解错误或某个功能的工作方式,我建议将 femme crate 作为依赖项添加,然后在 main() 函数的开始处添加此行

femme::with_level(log::LevelFilter::Trace);

在调试目标编译时,这提供了大量关于发生情况的几乎可读的输出。在目标为发布时,提供 JSON 结构化元数据,可以使用脚本或使用 jq 在 shell 中进行过滤和操作。

还有其他一些 crate 使用了 log crate 的新(不稳定)kv 功能,这只是我现在使用的其中一个。

示例

在您的 Cargo.toml 中,确保您启用了 toml 功能

[dependencies.mastodon-async]
version = "1.0"
features = ["toml", "mt"]

"mt"”功能是针对tokio多线程的。对于单线程,请删除“"mt"”功能,并将#[tokio::main]替换为#[tokio::main)flavor = "current_thread")]

// src/main.rs

use mastodon_async::prelude::*;
use mastodon_async::helpers::toml; // requires `features = ["toml"]`
use mastodon_async::{helpers::cli, Result};

#[tokio::main] // requires `features = ["mt"]
async fn main() -> Result<()> {
    let mastodon = if let Ok(data) = toml::from_file("mastodon-data.toml") {
        Mastodon::from(data)
    } else {
        register().await?
    };

    let you = mastodon.verify_credentials().await?;

    println!("{:#?}", you);

    Ok(())
}

async fn register() -> Result<Mastodon> {
    let registration = Registration::new("https://botsin.space")
                                    .client_name("mastodon-async-examples")
                                    .build()
                                    .await?;
    let mastodon = cli::authenticate(registration).await?;

    // Save app data for using on the next run.
    toml::to_file(&mastodon.data, "mastodon-data.toml")?;

    Ok(mastodon)
}

它还支持流式API

注意:此示例可以编译,但无法运行。请参阅log_events示例,其中包含更详细的示例,该示例可以编译并运行。

use mastodon_async::{prelude::*, Result, entities::event::Event};
use futures_util::TryStreamExt;

#[tokio::main]
async fn main() -> Result<()> {
    let client = Mastodon::from(Data::default());

    client.stream_user()
        .await?
        .try_for_each(|event| async move {
            match event {
                Event::Update(ref status) => { /* .. */ },
                Event::Notification(ref notification) => { /* .. */ },
                Event::Delete(ref id) => { /* .. */ },
                Event::FiltersChanged => { /* .. */ },
            }
            Ok(())
        })
        .await?;
    Ok(())
}

依赖项

~14–29MB
~534K SLoC