matrix-rust-sdk/matrix_sdk_base/src/error.rs

60 lines
1.9 KiB
Rust
Raw Normal View History

// Copyright 2020 Damir Jelić
// Copyright 2020 The Matrix.org Foundation C.I.C.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
2019-10-20 11:56:46 +00:00
//! Error conditions.
use serde_json::Error as JsonError;
use std::io::Error as IoError;
2020-03-18 13:15:56 +00:00
use thiserror::Error;
2019-10-20 11:56:46 +00:00
2020-03-18 13:15:56 +00:00
#[cfg(feature = "encryption")]
use matrix_sdk_crypto::{MegolmError, OlmError};
2019-10-20 11:56:46 +00:00
2020-03-18 13:15:56 +00:00
/// Result type of the rust-sdk.
pub type Result<T> = std::result::Result<T, Error>;
2019-10-20 11:56:46 +00:00
/// Internal representation of errors.
2020-03-18 13:15:56 +00:00
#[derive(Error, Debug)]
pub enum Error {
2019-10-20 11:56:46 +00:00
/// Queried endpoint requires authentication but was called on an anonymous client.
2020-03-18 13:15:56 +00:00
#[error("the queried endpoint requires authentication but was called before logging in")]
2019-10-20 11:56:46 +00:00
AuthenticationRequired,
/// A generic error returned when the state store fails not due to
/// IO or (de)serialization.
#[error("state store: {0}")]
StateStore(String),
/// An error when (de)serializing JSON.
#[error(transparent)]
SerdeJson(#[from] JsonError),
/// An error representing IO errors.
#[error(transparent)]
IoError(#[from] IoError),
/// An error occurred during a E2EE operation.
#[cfg(feature = "encryption")]
#[cfg_attr(docsrs, doc(cfg(feature = "encryption")))]
2020-03-18 13:15:56 +00:00
#[error(transparent)]
OlmError(#[from] OlmError),
/// An error occurred during a E2EE group operation.
#[cfg(feature = "encryption")]
#[cfg_attr(docsrs, doc(cfg(feature = "encryption")))]
#[error(transparent)]
MegolmError(#[from] MegolmError),
2019-10-20 11:56:46 +00:00
}