#twitch #pubsub #module #ttv-rs #endpoints

ttv-pubsub

ttv-rs的pubsub模块占位符

2个版本

0.1.1 2020年11月10日
0.1.0 2020年9月25日

#8 in #ttv-rs


用于 ttv-rs

MIT/Apache

2KB

ttv-rs

尝试统一Rust生态系统的Twitch API。

为什么?

这个crate集合的诞生源于创建一个"一统天下的库"的愿望,以Rust语言与Twitch API交互。最初我认为每个子crate可能都会依赖crates.io上的不同已存在的crate,或者在没有任何合适的选择时自己实现功能。然而,自从开始这个项目以来,我意识到我最初认为只打算覆盖Helix和TMI的twitch-api2 crate,实际上最终目标是覆盖大部分其他端点(参见此问题)。因此,这个库目前只提供了一种方法,可以将twitchchattwitch-api2结合在一个依赖项中,并使用更短的名字 😛

我还在考虑重新导出twitch_api2是否真的是实现以下目标最佳方式,但它看起来很有希望。然而,即使这个crate最终覆盖了所有端点,我可能还会尝试在其之上提供额外的便利功能,例如自动选择最佳端点的函数、利用REST或pubsub端点的聊天功能、Webhooks服务器、UI、数据库集成等...

目标

  • 覆盖Twitch文档中列出的所有API
  • 覆盖现在已知或未来发现的几个有用的非官方端点
  • 尽可能匹配Twitch文档的组织结构。
    • 这使得crate的用户更容易找到和交叉引用文档,并使用除Rust以外的技术的教程,同时也有助于贡献者添加文档。
  • 灵活性
    • 尽可能多的时候,这个crate应该是实现无关的(例如,能够支持各种异步运行时、网络实现、序列化库等)
    • 用户应该能够避免编译他们不需要的功能。
      • 然而,在我看来,一组合理的默认功能仍然至关重要。目前所有活动已弃用的API端点默认启用,但非官方端点则没有。

请注意,目前我对Museun的twitchchat存储库印象深刻,如果所有其他模块都能模仿其API并与之良好交互,那就更好了。例如,您应该能够为所有端点使用相同的异步执行器。

类似地,我支持sans-io的库设计方法,尽管如果库能提供与其他库的兼容性集成以实现IO,对最终用户来说会更好,这样可以减少样板代码。

此外,正如我之前所述,我的想法很大程度上受到Twitch4j设计的影响;然而,我不会完全遵循它。我对事情应该如何组织也有一些自己的看法。

进度

活动的Twitch API

功能 状态 当前实现
认证 … 测试 twitch_oauth2
聊天 … 测试 twitchchat
Helix … 测试 twitch_api2(仅包含helix功能)
扩展 ❌ 未实现
PubSub … 测试 twitch_api2(仅包含pubsub功能)
Webhooks ❌ 未实现

弃用的Twitch API

功能 状态 当前实现
v5(Kraken) ❌ 未实现 libtwitch-rs当前不兼容许可证)
遗留Drop ❌ 未实现

非官方Twitch API

功能 状态 当前实现
TMI … 测试 twitch_api2(仅包含tmi功能)
GraphQL ❌ 未实现

贡献

目前我主要在寻找关于我的愿景和想法的反馈,以及可能适合此项目的现有存储库。PR欢迎,但请注意,我可能对事情的组织和实现有很强的看法,并且可能会经常改变主意。

许可证

在MIT和Apache 2.0下授权

依赖关系

~2.2-3MB
~61K SLoC