Struct vtubestudio::data::ResponseEnvelope

pub struct ResponseEnvelope {
    pub api_name: Cow<'static, str>,
    pub api_version: Cow<'static, str>,
    pub timestamp: i64,
    pub request_id: RequestId,
    pub data: Result<ResponseData, ApiError>,
}

A VTube Studio API response.

Fields

api_name: Cow<'static, str>

API name, typically "VTubeStudioPublicAPI".

api_version: Cow<'static, str>

API version, typically "1.0".

timestamp: i64

Unix timestamp (in milliseconds) of the response.

request_id: RequestId

The original request ID.

data: Result<ResponseData, ApiError>

Response data, which could be an ApiError.

Implementations

impl ResponseEnvelope

pub fn new<Resp>(data: &Resp) -> Result<Self, Error>

where Resp: Response + Serialize,

Creates a new response with the underlying typed data.

pub fn with_id(self, id: RequestId) -> Self

Sets the request ID.

pub fn set_data<Resp>(&mut self, data: &Resp) -> Result<(), Error>

where Resp: Response + Serialize,

Sets the data field of a response.

pub fn message_type(&self) -> &EnumString<ResponseType>

The message type of this response.

pub fn parse<Resp: Response>(self) -> Result<Resp, Error>

Attempts to parse the response into a the given Response type.

This can return an error if the message type is an ApiError or isn’t the expected type.

pub fn parse_event(self) -> Result<Event, Error>

Attempts to parse the response as an Event.

This can return an error if the message type is an ApiError or has an unexpected JSON structure. If the message type is not a known Event variant, it will be returned as Event::Unknown instead of an error.

pub fn is_api_error(&self) -> bool

Returns true if the message type is APIError.

pub fn is_unauthenticated_error(&self) -> bool

Returns true if the message is an APIError with ErrorId::REQUEST_REQUIRES_AUTHENTICATION.

Trait Implementations

impl Clone for ResponseEnvelope

fn clone(&self) -> ResponseEnvelope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseEnvelope

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

Formats the value using the given formatter.

impl Default for ResponseEnvelope

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ResponseEnvelope

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Policy<RequestEnvelope, ResponseEnvelope, Error> for RetryPolicy

type Future = Ready<RetryPolicy>

The Future type returned by Policy::retry.

fn retry( &self, req: &RequestEnvelope, result: Result<&ResponseEnvelope, &Error>, ) -> Option<Self::Future>

Check the policy if a certain request should be retried.

fn clone_request(&self, req: &RequestEnvelope) -> Option<RequestEnvelope>

Tries to clone a request before being passed to the inner service.

impl Serialize for ResponseEnvelope

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.