jsonrpsee_core/client/error.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
// Copyright 2019-2021 Parity Technologies (UK) Ltd.
//
// Permission is hereby granted, free of charge, to any
// person obtaining a copy of this software and associated
// documentation files (the "Software"), to deal in the
// Software without restriction, including without
// limitation the rights to use, copy, modify, merge,
// publish, distribute, sublicense, and/or sell copies of
// the Software, and to permit persons to whom the Software
// is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice
// shall be included in all copies or substantial portions
// of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
// ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
// TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
// SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
// IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//! Error type for client(s).
use crate::{params::EmptyBatchRequest, BoxError, RegisterMethodError};
use jsonrpsee_types::{ErrorObjectOwned, InvalidRequestId};
use std::sync::Arc;
/// Error type.
#[derive(Debug, thiserror::Error)]
pub enum Error {
/// JSON-RPC error which can occur when a JSON-RPC call fails.
#[error("{0}")]
Call(#[from] ErrorObjectOwned),
/// Networking error or error on the low-level protocol layer.
#[error(transparent)]
Transport(BoxError),
/// The background task has been terminated.
#[error("The background task closed {0}; restart required")]
RestartNeeded(Arc<Error>),
/// Failed to parse the data.
#[error("Parse error: {0}")]
ParseError(#[from] serde_json::Error),
/// Invalid subscription ID.
#[error("Invalid subscription ID")]
InvalidSubscriptionId,
/// Invalid request ID.
#[error(transparent)]
InvalidRequestId(#[from] InvalidRequestId),
/// Request timeout
#[error("Request timeout")]
RequestTimeout,
/// Custom error.
#[error("Custom error: {0}")]
Custom(String),
/// Not implemented for HTTP clients.
#[error("Not implemented")]
HttpNotImplemented,
/// Empty batch request.
#[error(transparent)]
EmptyBatchRequest(#[from] EmptyBatchRequest),
/// The error returned when registering a method or subscription failed.
#[error(transparent)]
RegisterMethod(#[from] RegisterMethodError),
}