Enum misskey_core::model::ApiResult

#[must_use =
  "this `ApiResult` may be an `Err` variant, which should be handled"]pub enum ApiResult<T> {
    Err {
        error: ApiError,
    },
    Ok(T),
}

Result type that represents immediate response from Misskey.

ApiResult is either successful response (ApiResult::Ok) or an error (ApiResult::Err) with ApiError. We implement this type in a way that distinguishes it from the Result<T, ApiError>, since the ApiResult is a normal response to a successful request, even if it is an ApiResult::Err. (see the return type of crate::Client::request)

You can convert ApiResult<T> to Result<T, ApiError> by using Into::into or ApiResult::into_result.

Variants

Err

Contains the error value, namely ApiError.

Fields of Err

error: ApiError

The error returned from Misskey.

Ok(T)

Contains the success value.

Implementations

impl<T> ApiResult<T>

pub fn into_result(self) -> Result<T, ApiError>

Converts ApiResult to Result for convenient handling.

You can also use Into::into, but this is preferred as it expresses the intent more clearly.

pub fn ok(self) -> Option<T>

Converts ApiResult<T> to Option<T>, consuming self, and discarding the error, if any.

pub fn err(self) -> Option<ApiError>

Converts ApiResult<T> to Option<ApiError>, consuming self, and discarding the success value, if any.

pub fn is_ok(&self) -> bool

Returns true if the API result is ApiResult::Ok.

pub fn is_err(&self) -> bool

Returns true if the API result is ApiResult::Err.

pub fn expect(self, msg: &str) -> T

Returns the contained ApiResult::Ok value, consuming the self value.

Panics

Panics if the value is an ApiResult::Err, with a panic message including the passed message, and the content of the ApiResult::Err.

pub fn unwrap(self) -> T

Returns the contained ApiResult::Ok value, consuming the self value.

Panics

Panics if the value is an ApiResult::Err, with a panic message provided by the ApiResult::Err's value.

pub fn map<U, F>(self, op: F) -> ApiResult<U> where
    F: FnOnce(T) -> U, 

Maps a ApiResult<T> to ApiResult<U> by applying a function to a contained ApiResult::Ok value, leaving an ApiResult::Err value untouched.

Trait Implementations

impl<T: Clone> Clone for ApiResult<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ApiResult<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for ApiResult<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> Into<Result<T, ApiError>> for ApiResult<T>

fn into(self) -> Result<T, ApiError>

Converts ApiResult to Result for convenient handling.

impl<T> Serialize for ApiResult<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.