Skip to main content

Crate verhub_sdk

Crate verhub_sdk 

Source
Expand description

Verhub Rust SDK。

接口面与 Python / TypeScript / 纯 JS 版一一对应,方法名按 Rust 习惯写成 snake_case。契约以仓库根目录的 verhub.openapi.yaml 为准。

use verhub_sdk::{models::CheckUpdateInput, VerhubClient};

let client = VerhubClient::builder("https://verhub.example.com/api/v1")
    .project_key("verhub")
    .build()?;

let result = client
    .public()
    .check_update(&CheckUpdateInput {
        current_version: Some("1.1.0".into()),
        ..Default::default()
    })
    .await?;

if result.should_update {
    println!("{}", result.latest_version.version);
}

Re-exports§

pub use models::LogLevel;
pub use models::Platform;
pub use models::TermsDocumentSlug;

Modules§

models
请求与响应类型。

Structs§

AdminApi
管理接口,全部需要凭据。
AnalyticsOptions
事件采集配置。
EventBatch
一次上报的载荷。
EventQueue
事件队列:攒批入队,满一批或距上次发送超过 flush_interval 时要求发送。
PublicApi
公开接口,不需要凭据。
QueuedEvent
队列里的一条事件。
VerhubClient
Verhub SDK 入口。
VerhubClientBuilder
crate::VerhubClient 的构建器。

Enums§

AnalyticsPersistence
匿名标识的持久化程度。
Error
SDK 错误。

Constants§

CLIENT_TIME_HEADER
客户端本地时间头;服务端从偏移取时区,从时刻算设备时钟偏差。
PLATFORM_HEADER
客户端平台声明头。仅用于服务端请求统计,不影响接口返回内容。
PLATFORM_VERSION_HEADER
客户端系统版本明细头,如 11 / ubuntu 24.04;超过 32 字符会被服务端丢弃。
VERHUB_SDK_VERSION
SDK 版本号,跟随主仓库版本。

Functions§

analytics_namespace
本地状态的命名空间:<origin 哈希>-<小写 project_key>。
detect_platform
探测当前运行平台,用于填充 PLATFORM_HEADER。
detect_platform_version
探测系统版本明细,用于填充 PLATFORM_VERSION_HEADER。
fnv1a32_hex
FNV-1a 32 位,按 UTF-8 字节计算,输出 8 位小写 hex。
origin_of
取 base_url 的 origin(协议 + 主机 + 端口),路径一律忽略。

Type Aliases§

Result
SDK 统一结果类型。