Enum BpiError 

pub enum BpiError {
    Network {
        message: String,
    },
    Transport {
        source: Error,
    },
    Http {
        status: u16,
    },
    HttpStatus {
        status: u16,
    },
    Parse {
        message: String,
    },
    Decode {
        source: Error,
    },
    Api {
        code: i32,
        message: String,
        category: ErrorCategory,
    },
    Authentication {
        message: String,
    },
    Auth {
        message: String,
    },
    InvalidParameter {
        field: &'static str,
        message: &'static str,
    },
    MissingData,
    UnsupportedResponse {
        message: String,
    },
}

Variants

Network

网络请求失败

Fields

message: String

Transport

transport 层请求失败。

Fields

source: Error

Http

HTTP状态码错误

Fields

status: u16

HttpStatus

HTTP 状态错误。

Fields

status: u16

Parse

JSON解析失败

Fields

message: String

Decode

响应解码失败。

Fields

source: Error

Api

API返回的业务错误

Fields

code: i32

message: String

category: ErrorCategory

Authentication

验证错误

Fields

message: String

Auth

认证或授权错误。

Fields

message: String

InvalidParameter

参数错误

Fields

field: &'static str

message: &'static str

MissingData

API 响应成功，但未包含必需的 payload 数据。

UnsupportedResponse

当前解析器不支持该响应格式。

Fields

message: String

Implementations

impl BpiError

pub fn missing_csrf() -> Self

pub fn missing_data() -> Self

pub fn auth_required() -> Self

impl BpiError

生成Error的From实现

pub fn from_code(code: i32) -> Self

根据API错误码创建BpiError

pub fn from_code_message(code: i32, message: String) -> Self

pub fn from_api_response<T>(resp: ApiEnvelope<T>) -> Self

从API响应创建BpiError

impl BpiError

获取错误属性

pub fn code(&self) -> Option<i32>

获取错误码

pub fn http_status(&self) -> Option<u16>

获取 HTTP 状态码

pub fn category(&self) -> ErrorCategory

获取错误分类

impl BpiError

错误创建函数

pub fn network(message: impl Into<String>) -> Self

创建网络错误

pub fn http(status: u16) -> Self

创建HTTP错误

pub fn parse(message: impl Into<String>) -> Self

创建解析错误

pub fn invalid_parameter(field: &'static str, message: &'static str) -> Self

创建参数错误

Examples found in repository

examples/live_room_info.rs (line 15)

fn room_id() -> BpiResult<i64> {
    match std::env::var("BILI_ROOM_ID") {
        Ok(value) => value.parse().map_err(|_| {
            BpiError::invalid_parameter("room_id", "room id must be a signed integer")
        }),
        Err(_) => Ok(DEFAULT_ROOM_ID),
    }
}

pub fn auth(message: impl Into<String>) -> Self

pub fn unsupported_response(message: impl Into<String>) -> Self

创建不支持响应错误。

impl BpiError

错误判断

pub fn requires_login(&self) -> bool

判断是否需要用户登录

pub fn is_permission_error(&self) -> bool

判断是否为权限问题

pub fn requires_vip(&self) -> bool

判断是否需要VIP权限

pub fn is_risk_control(&self) -> bool

判断是否为风控拦截

Examples found in repository

examples/login_status.rs (line 35)

async fn main() -> BpiResult<()> {
    let client = account::authenticated_client()?;
    let login = client.login();

    let nav = login.nav().await?;
    println!(
        "登录状态: is_login={} mid={:?} uname={}",
        nav.is_login,
        nav.mid,
        nav.uname.as_deref().unwrap_or("<unknown>")
    );

    let coin = login.coin().await?;
    println!("硬币余额: {:.2}", coin.money);

    match login.daily_reward().await {
        Ok(reward) => println!(
            "每日奖励: login={} watch={} coins={} share={}",
            reward.login, reward.watch, reward.coins, reward.share
        ),
        Err(err) if err.is_risk_control() => {
            println!("每日奖励: 当前请求被风控拦截，已跳过 ({err})");
        }
        Err(err) => return Err(err),
    }

    let vip = login.vip_info().await?;
    println!(
        "VIP: active={} type={} status={}",
        vip.is_active(),
        vip.vip_type,
        vip.vip_status
    );

    Ok(())
}

pub fn is_business_error(&self) -> bool

判断是否为业务逻辑错误

pub fn semantic_error(&self) -> Option<&'static str>

获取可写入契约的稳定语义错误标签

Trait Implementations

impl Debug for BpiError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for BpiError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for BpiError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl<T> From<ApiEnvelope<T>> for BpiError

fn from(resp: ApiEnvelope<T>) -> Self

Converts to this type from the input type.

impl From<Error> for BpiError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for BpiError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl Serialize for BpiError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.