cedar_policy_core/entities/
err.rs

1/*
2 * Copyright 2022-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
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 thiserror::Error;
20
21/// Error type for errors raised in entities.rs.
22#[derive(Debug, Error)]
23pub enum EntitiesError {
24    /// Error occurring in serialization of entities
25    #[error("error during entity serialization: {0}")]
26    Serialization(#[from] crate::entities::JsonSerializationError),
27    /// Error occurring in deserialization of entities
28    #[error("error during entity deserialization: {0}")]
29    Deserialization(#[from] crate::entities::JsonDeserializationError),
30    /// Error constructing the `[crate::entities::Entities]` as there is a duplicate Entity UID
31    #[error("duplicate entity entry `{0}`")]
32    Duplicate(EntityUID),
33    /// Errors occurring while computing or enforcing transitive closure on the
34    /// entity hierarchy.
35    #[error("transitive closure computation/enforcement error: {0}")]
36    TransitiveClosureError(#[from] Box<transitive_closure::TcError<EntityUID>>),
37    /// Error because an entity doesn't conform to the schema
38    #[error("entity does not conform to the schema: {0}")]
39    InvalidEntity(#[from] crate::entities::EntitySchemaConformanceError),
40}
41
42/// Type alias for convenience
43pub type Result<T> = std::result::Result<T, EntitiesError>;