dusk-safe 0.3.0

Sponge API for Field Elements
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
//
// Copyright (c) DUSK NETWORK. All rights reserved.

/// Defines all possible error variants for the SAFE library.
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum Error {
    /// This error occurs when the expected IO-pattern sequence wasn't followed
    /// during the usage of the sponge algorithm.
    IOPatternViolation,

    /// This error occurs when the provided IO-pattern is not valid.
    /// This means that one of the following is not met:
    /// - It doesn't start with a call to squeeze
    /// - It doesn't end with a call to absorb
    /// - Every call to absorb or squeeze has a length between 0 < len < 2^31
    InvalidIOPattern,

    /// This error occurs when the input elements provided to the
    /// [`Sponge::absorb`] are less than the amount that should be absorbed.
    TooFewInputElements,

    /// This error indicates a failure during the encryption process.
    EncryptionFailed,

    /// This error indicates a failure during the decryption process.
    DecryptionFailed,
}