#speedrun #api-wrapper #com #user #cover #api #coms

speedrunapi

speedrun.com API 的 Rust 风格包装器!

5 个不稳定版本

0.3.0 2023年3月24日
0.2.0 2023年3月1日
0.1.2 2023年2月19日
0.1.1 2023年2月17日
0.1.0 2023年2月15日

#6 in #cover

MIT 协议

62KB
877

Speedrunapi

*Rust 版本

speedrunapi crate 的目标是帮助更容易地处理 speedrun.com 的 REST API。

目前这个项目还处于非常初期的阶段,希望能够高效、简单地涵盖所有可能的内容。对项目的任何帮助都将非常感激!

这个项目是为了娱乐和练习 Rust 编程技能而制作的,所以我希望有人能从中受益。

注意: 0.3.0 是项目的重大重写,导致大多数内容都有破坏性变化。

基本用法

use speedrunapi::GameData;
let result = GameData::new("Mc").run();
assert_eq!(result.name(), "Minecraft: Java Edition");

这会获取一个游戏的名字。

use speedrunapi::UserData;
let result = UserData::new("fishin_rod").run();
assert_eq!(result.id(), "jonryvl8");

这会获取一个用户的 id。

有关此 crate 的更多信息,请参阅文档!


lib.rs:

Speedrunapi

speedrun.com API 的 REST API 包装器

Speedrunapi 旨在使使用 speedrun.com API 快速且简单

Speedrunapi 提供

  • 数据预格式化
  • 易于使用的结构
  • ids/times 的翻译(目前尚未使用,但很快将使用更多!)
  • 错误处理

当前模块

用户数据

此模块提供有关 speedrun.com 上用户的数据。

用户有许多与之相关的数据点。

用户数据模块允许使用此 crate 的人获取这些数据点并使用它们!

示例

我正在使用用户:Bobertness 作为示例,以展示角色。 这是一个真实用户!

use speedrunapi::UserData;
let result = UserData::new("Bobertness").run();
assert_eq!(result.role(), "user");

访客数据

此模块提供有关 speedrun.com 上访客的数据

访客是 speedrun.com 处理尚未创建账户/未登录账户的用户的处理方式。

访客只有名称和一个与之相关的链接。

游戏数据

此模块提供有关 speedrun.com 上游戏的数据

游戏是用户可以在 speedrun.com 上提交跑分的地方。

游戏有许多与之相关的数据点。还有一些与游戏相关的数据点,但需要使用新的模块(进行中)。

示例

此示例显示了获取游戏链接。

use speedrunapi::GameData;
let result = GameData::new("MC").run();
assert_eq!(result.weblink(), "https://www.speedrun.com/mc");

游戏类型

此模块提供有关游戏类型的数据

什么是游戏类型?

根据 speedrun.com: (游戏类型是不官方游戏的分类,例如 ROM Hack、Fangame、修改等。)

游戏类型只有名称、id 和与之相关的链接。

关卡


*此 crate 受 MIT 协议许可

依赖项

~7–19MB
~284K SLoC