cedar_policy_core/entities/err.rs
1/*
2 * Copyright Cedar Contributors
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * https://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17use super::EntityUID;
18use crate::transitive_closure;
19use miette::Diagnostic;
20use thiserror::Error;
21
22/// Error type for errors raised in entities.rs.
23#[derive(Debug, Diagnostic, Error)]
24pub enum EntitiesError {
25 /// Error occurring in serialization of entities
26 #[error("error during entity serialization: {0}")]
27 #[diagnostic(transparent)]
28 Serialization(#[from] crate::entities::JsonSerializationError),
29 /// Error occurring in deserialization of entities
30 #[error("error during entity deserialization: {0}")]
31 #[diagnostic(transparent)]
32 Deserialization(#[from] crate::entities::JsonDeserializationError),
33 /// Error constructing the `[crate::entities::Entities]` as there is a duplicate Entity UID
34 #[error("duplicate entity entry `{0}`")]
35 Duplicate(EntityUID),
36 /// Errors occurring while computing or enforcing transitive closure on the
37 /// entity hierarchy.
38 #[error("transitive closure computation/enforcement error: {0}")]
39 #[diagnostic(transparent)]
40 TransitiveClosureError(#[from] Box<transitive_closure::TcError<EntityUID>>),
41 /// Error because an entity doesn't conform to the schema
42 #[error("entity does not conform to the schema: {0}")]
43 #[diagnostic(transparent)]
44 InvalidEntity(#[from] crate::entities::EntitySchemaConformanceError),
45}
46
47/// Type alias for convenience
48pub type Result<T> = std::result::Result<T, EntitiesError>;