Struct ApiEnvelope 

pub struct ApiEnvelope<T> {
    pub code: i32,
    pub data: Option<T>,
    pub message: String,
    pub status: bool,
}

大多数 Web API endpoint 使用的标准 Bilibili JSON envelope。

Fields

code: i32

API 返回码。0 表示成功。

data: Option<T>

成功 endpoint 返回的 payload。

message: String

API 消息。Bilibili 成功时常返回 "0"。

status: bool

部分 endpoint 返回的可选状态标记。

Implementations

impl<T> ApiEnvelope<T>

pub fn from_slice(bytes: &[u8]) -> BpiResult<Self>

where T: DeserializeOwned,

从字节解析 JSON envelope。

pub fn ensure_success(self) -> BpiResult<Self>

如果此 envelope 表示成功的 API 响应，则返回它。

pub fn into_payload(self) -> BpiResult<T>

从成功响应中提取必需 payload。

pub fn into_optional_payload(self) -> BpiResult<Option<T>>

从成功响应中提取可选 payload。

pub fn into_data(self) -> Result<T, BpiError>

不检查响应码，直接提取必需 payload。

这是为 payload 包含业务状态的 endpoint 保留的，例如 QR 轮询。

Trait Implementations

impl<T: Clone> Clone for ApiEnvelope<T>

fn clone(&self) -> ApiEnvelope<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for ApiEnvelope<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for ApiEnvelope<T>

where T: Deserialize<'de>,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

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

Converts to this type from the input type.

impl<T> Serialize for ApiEnvelope<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.