error.rs

/*
 * SPDX-License-Identifier: AGPL-3.0-only
 *
 * This file is part of HarTex.
 *
 * HarTex
 * Copyright (c) 2021-2025 HarTex Project Developers
 *
 * HarTex is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * HarTex is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License along
 * with HarTex. If not, see <https://www.gnu.org/licenses/>.
 */

//! # Entity Cache Errors

use std::env::VarError;
use std::error::Error;
use std::fmt;
use std::fmt::Display;
use std::fmt::Formatter;

use hartex_database_queries::result::Error as DatabaseError;

/// A cache error..
#[allow(clippy::module_name_repetitions)]
#[derive(Debug)]
pub enum CacheError {
    /// Error related to environment variables.
    Env(VarError),
    /// A postgres error occurred.
    Database(DatabaseError),
}

impl Display for CacheError {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        match self {
            Self::Env(error) => writeln!(f, "env error: {error}"),
            Self::Database(error) => writeln!(f, "database error: {error}"),
        }
    }
}

impl Error for CacheError {}

impl From<DatabaseError> for CacheError {
    fn from(error: DatabaseError) -> Self {
        Self::Database(error)
    }
}

impl From<VarError> for CacheError {
    fn from(error: VarError) -> Self {
        Self::Env(error)
    }
}

pub type CacheResult<T> = Result<T, CacheError>;