/* * * Copyright (c) 2020-2022 Project CHIP Authors * * 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. */ use core::{array::TryFromSliceError, fmt, str::Utf8Error}; #[derive(Debug, PartialEq, Eq, Clone, Copy)] pub enum ErrorCode { AttributeNotFound, AttributeIsCustom, BufferTooSmall, ClusterNotFound, CommandNotFound, Duplicate, EndpointNotFound, InvalidAction, InvalidCommand, InvalidDataType, UnsupportedAccess, ResourceExhausted, Busy, DataVersionMismatch, Crypto, TLSStack, MdnsError, Network, NoCommand, NoEndpoint, NoExchange, NoFabricId, NoHandler, NoNetworkInterface, NoNodeId, NoMemory, NoSession, NoSpace, NoSpaceAckTable, NoSpaceRetransTable, NoTagFound, NotFound, PacketPoolExhaust, StdIoError, SysTimeFail, Invalid, InvalidAAD, InvalidData, InvalidKeyLength, InvalidOpcode, InvalidPeerAddr, // Invalid Auth Key in the Matter Certificate InvalidAuthKey, InvalidSignature, InvalidState, InvalidTime, InvalidArgument, RwLock, TLVNotFound, TLVTypeMismatch, TruncatedPacket, Utf8Fail, } impl From for Error { fn from(code: ErrorCode) -> Self { Self::new(code) } } pub struct Error { code: ErrorCode, #[cfg(all(feature = "std", feature = "backtrace"))] backtrace: std::backtrace::Backtrace, } impl Error { pub fn new(code: ErrorCode) -> Self { Self { code, #[cfg(all(feature = "std", feature = "backtrace"))] backtrace: std::backtrace::Backtrace::capture(), } } pub const fn code(&self) -> ErrorCode { self.code } #[cfg(all(feature = "std", feature = "backtrace"))] pub const fn backtrace(&self) -> &std::backtrace::Backtrace { &self.backtrace } pub fn remap(self, matcher: F, to: Self) -> Self where F: FnOnce(&Self) -> bool, { if matcher(&self) { to } else { self } } pub fn map_invalid(self, to: Self) -> Self { self.remap( |e| matches!(e.code(), ErrorCode::Invalid | ErrorCode::InvalidData), to, ) } pub fn map_invalid_command(self) -> Self { self.map_invalid(Error::new(ErrorCode::InvalidCommand)) } pub fn map_invalid_action(self) -> Self { self.map_invalid(Error::new(ErrorCode::InvalidAction)) } pub fn map_invalid_data_type(self) -> Self { self.map_invalid(Error::new(ErrorCode::InvalidDataType)) } } #[cfg(feature = "std")] impl From for Error { fn from(_e: std::io::Error) -> Self { // Keep things simple for now Self::new(ErrorCode::StdIoError) } } #[cfg(feature = "std")] impl From> for Error { fn from(_e: std::sync::PoisonError) -> Self { Self::new(ErrorCode::RwLock) } } #[cfg(feature = "openssl")] impl From for Error { fn from(e: openssl::error::ErrorStack) -> Self { ::log::error!("Error in TLS: {}", e); Self::new(ErrorCode::TLSStack) } } #[cfg(all(feature = "mbedtls", not(target_os = "espidf")))] impl From for Error { fn from(e: mbedtls::Error) -> Self { ::log::error!("Error in TLS: {}", e); Self::new(ErrorCode::TLSStack) } } #[cfg(target_os = "espidf")] impl From for Error { fn from(e: esp_idf_sys::EspError) -> Self { ::log::error!("Error in ESP: {}", e); Self::new(ErrorCode::TLSStack) // TODO: Not a good mapping } } #[cfg(feature = "rustcrypto")] impl From for Error { fn from(_e: ccm::aead::Error) -> Self { Self::new(ErrorCode::Crypto) } } #[cfg(feature = "std")] impl From for Error { fn from(_e: std::time::SystemTimeError) -> Self { Error::new(ErrorCode::SysTimeFail) } } impl From for Error { fn from(_e: TryFromSliceError) -> Self { Self::new(ErrorCode::Invalid) } } impl From for Error { fn from(_e: Utf8Error) -> Self { Self::new(ErrorCode::Utf8Fail) } } impl fmt::Debug for Error { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { #[cfg(not(all(feature = "std", feature = "backtrace")))] { write!(f, "Error::{}", self)?; } #[cfg(all(feature = "std", feature = "backtrace"))] { writeln!(f, "Error::{} {{", self)?; write!(f, "{}", self.backtrace())?; writeln!(f, "}}")?; } Ok(()) } } impl fmt::Display for Error { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { write!(f, "{:?}", self.code()) } } #[cfg(feature = "std")] impl std::error::Error for Error {}