Sunscreen/sunscreen_runtime/src/error.rs

use crate::Type;

#[derive(Debug, Clone, PartialEq)]
/**
 * Represents an error that can occur in this crate.
 */
pub enum Error {
    /**
     * An issue with an [`Circuit`](sunscreen_circuit::Circuit).
     */
    IRError(sunscreen_circuit::Error),

    /**
     * An error occurred in the SEAL library.
     */
    SealError(seal::Error),

    /**
     * Tried to run a circuit that requires relinearization keys, but didn't provide any.
     */
    MissingRelinearizationKeys,

    /**
     * Tried to run a circuit that requires Galois keys, but didn't provide any.
     */
    MissingGaloisKeys,

    /**
     * Returned when:
     * * The wrong number of ciphertexts were provided as parameters to a circuit.
     * * The wrong number of ciphertexts were returned from a circuit.
     */
    IncorrectCiphertextCount,

    /**
     * An argument is incompatible with the parameters in the runtime.
     */
    ParameterMismatch,

    /**
     * The given arguments do not match the call signature of the circuit.
     */
    ArgumentMismatch {
        /**
         * The arguments in the call signature of the circuit.
         */
        expected: Vec<Type>,

        /**
         * The given arguments.
         */
        actual: Vec<Type>,
    },

    /**
     * The given return types do not match the circuit interface.
     */
    ReturnMismatch {
        /**
         * The return types in the call signature of the circuit.
         */
        expected: Vec<Type>,

        /**
         * The given return types.
         */
        actual: Vec<Type>,
    },

    /**
     * The given type does not match the expected.
     */
    TypeMismatch {
        /**
         * The expected type.
         */
        expected: Type,

        /**
         * The actual type.
         */
        actual: Type,
    },

    /**
     * The vector indicating the number of ciphertexts in the return types isn't the same length
     * as the signature's return type. Running valid circuits created by the Sunscreen compiler
     * should never produce this error.
     */
    ReturnTypeMetadataError,

    /**
     * Decryption failed because the cipher text had too much noise.
     */
    TooMuchNoise,

    /**
     * Executing a circuit failed.
     */
    CircuitRunError(crate::run::CircuitRunFailure),

    /**
     * This variant wraps some error specific to the representation of FheTypes. For example,
     * a type encoding even numbers would return this if you pass an odd number.
     */
    FheTypeError(String),

    /**
     * Failed to deserialize bytes as a [`Params`](crate::Params) object.
     */
    ParamDeserializationError,

    /**
     * The given [`Plaintext`](crate::Plaintext) had no data.
     */
    NoPlaintextData,

    /**
     * An error occurred when serializing/deserializing with bincode.
     */
    BincodeError(String),

    /**
     * Called [`inner_as_seal_plaintext`](crate::InnerPlaintext.inner_as_seal_plaintext)
     * on non-Seal plaintext.
     */
    NotASealPlaintext,
}

impl From<bincode::Error> for Error {
    fn from(err: bincode::Error) -> Self {
        Self::BincodeError(format!("{}", err))
    }
}

impl From<sunscreen_circuit::Error> for Error {
    fn from(err: sunscreen_circuit::Error) -> Self {
        Self::IRError(err)
    }
}

impl From<seal::Error> for Error {
    fn from(err: seal::Error) -> Self {
        Self::SealError(err)
    }
}

impl From<crate::run::CircuitRunFailure> for Error {
    fn from(err: crate::run::CircuitRunFailure) -> Self {
        Self::CircuitRunError(err)
    }
}

/**
 * Wrapper around [`Result`](std::result::Result) with this crate's error type.
 */
pub type Result<T> = std::result::Result<T, Error>;