activitystreams_traits/error.rs
1/*
2 * This file is part of ActivityStreams Traits.
3 *
4 * Copyright © 2018 Riley Trautman
5 *
6 * ActivityStreams Traits is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * ActivityStreams Traits is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with ActivityStreams Traits. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20use std::result;
21
22/// The Error type
23#[derive(Copy, Clone, Debug, Eq, PartialEq, thiserror::Error)]
24pub enum Error {
25 /// This error occurs when an Activity Streams type does not contain a requested value
26 #[error("Key not present")]
27 NotFound,
28
29 /// This error occurs when a requested value could not be deserialized into the requested type
30 #[error("Failed to deserialize data as requested type")]
31 Deserialize,
32
33 /// This error occurs when a provided item could not be serialized into an Activity Streams
34 /// type
35 #[error("Failed to serialize data")]
36 Serialize,
37}
38
39/// An alias for Result<T, Error>
40pub type Result<T> = result::Result<T, Error>;