Struct ApiEnvelope 

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

Canonical Bilibili JSON envelope used by most web API endpoints.

Fields

code: i32

API return code. 0 means success.

data: Option<T>

Payload returned by successful endpoints.

message: String

API message. Bilibili often returns "0" for success.

status: bool

Optional status flag returned by some endpoints.

Implementations

impl<T> ApiEnvelope<T>

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

where T: DeserializeOwned,

Parses a JSON envelope from bytes.

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

Returns this envelope if it represents a successful API response.

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

Extracts a required payload from a successful response.

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

Extracts an optional payload from a successful response.

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

Extracts a required payload without checking the response code.

This is kept for endpoints whose payload contains the business status, such as QR polling.

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.