nuts_container/error.rs
1// MIT License
2//
3// Copyright (c) 2022-2024 Robin Doer
4//
5// Permission is hereby granted, free of charge, to any person obtaining a copy
6// of this software and associated documentation files (the "Software"), to
7// deal in the Software without restriction, including without limitation the
8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22
23use nuts_backend::Backend;
24use thiserror::Error as ThisError;
25
26use crate::cipher::CipherError;
27use crate::header::HeaderError;
28
29/// Error type used by this module.
30#[derive(Debug, ThisError)]
31pub enum Error<B: Backend> {
32 /// An error occured in the attached backend.
33 #[error(transparent)]
34 Backend(B::Err),
35
36 /// A cipher related error
37 #[error(transparent)]
38 Cipher(#[from] CipherError),
39
40 /// Errors coming from header evaluation.
41 #[error(transparent)]
42 Header(#[from] HeaderError),
43}
44
45pub type ContainerResult<T, B> = Result<T, Error<B>>;