Struct Error 

pub struct Error { /* private fields */ }

Represents errors that can occur while communicating with the VTube Studio API.

Implementations

impl Error

pub fn new(kind: ErrorKind) -> Self

Creates a new Error.

pub fn to_api_error(&self) -> Option<&ApiError>

Returns the underlying ApiError, if any.

pub fn with_source<E: Into<BoxError>>(self, source: E) -> Self

Sets this error’s underlying source.

pub fn into_source(self) -> Option<Box<dyn StdError + Send + Sync>>

Consumes the error, returning its source.

pub fn is_api_error(&self) -> bool

Returns true if this error has an underlying ApiError.

pub fn is_unauthenticated_error(&self) -> bool

Returns true if this error’s underlying ApiError is an authentication error.

pub fn from_boxed(error: BoxError) -> Self

Converts a BoxError into this error type. If the underlying Error is not this error type, a new Error is created with ErrorKind::Other.

pub fn kind(&self) -> &ErrorKind

Returns the ErrorKind of this error.

pub fn has_kind(&self, kind: ErrorKind) -> bool

Checks if any error in this error’s source chain matches the given ErrorKind.

pub fn find_source<E: StdError + 'static>(&self) -> Option<&E>

Recurses through this error’s source chain, returning the first matching error type.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 From<ApiError> for Error

fn from(error: ApiError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<ErrorKind> for Error

fn from(kind: ErrorKind) -> Self

Converts to this type from the input type.

impl From<UnexpectedResponseError> for Error

fn from(error: UnexpectedResponseError) -> Self

Converts to this type from the input type.

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.