feagi-structures 0.0.12

The most core library, defines the basic data types used by FEAGI, as well as some processors to modify them
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

use std::error::Error;
use std::fmt::{Display, Formatter};

/// Common error type for FEAGI data operations.
///
/// Provides structured error handling for serialization, deserialization,
/// validation, and internal errors across the FEAGI data processing pipeline.
///
/// # Examples
/// ```
/// use feagi_structures::FeagiDataError;
///
/// fn validate_count(count: u32) -> Result<(), FeagiDataError> {
///     if count == 0 {
///         return Err(FeagiDataError::BadParameters("Count must be > 0".into()));
///     }
///     Ok(())
/// }
///
/// assert!(validate_count(0).is_err());
/// assert!(validate_count(5).is_ok());
/// ```
#[derive(Debug)]
pub enum FeagiDataError {
    /// Failed to deserialize bytes into data structures
    DeserializationError(String),
    /// Failed to serialize data structures into bytes
    SerializationError(String),
    /// Invalid parameters provided to a function
    BadParameters(String),
    /// Error related to neuron operations
    NeuronError(String),
    /// Internal error indicating a bug (please report)
    InternalError(String),
    /// resource is locked while system is running
    ResourceLockedWhileRunning(String),
    /// failed to process something in a const function
    ConstError(&'static str),
    /// Feature not yet implemented
    NotImplemented,
}

impl Display for FeagiDataError {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            FeagiDataError::DeserializationError(msg) => {
                write!(f, "Failed to Deserialize Bytes: {}", msg)
            }
            FeagiDataError::SerializationError(msg) => {
                write!(f, "Failed to Serialize Bytes: {}", msg)
            }
            FeagiDataError::BadParameters(msg) => write!(f, "Bad Parameters: {}", msg),
            FeagiDataError::NeuronError(msg) => write!(f, "NeuronError: {}", msg),
            FeagiDataError::InternalError(msg) => write!(
                f,
                "Internal Error, please raise an issue on Github: {}",
                msg
            ),
            FeagiDataError::ResourceLockedWhileRunning(msg) => {
                write!(f, "Resource Locked While Running: {}", msg)
            }
            FeagiDataError::ConstError(msg) => write!(f, "ConstError: {}", msg),
            FeagiDataError::NotImplemented => write!(
                f,
                "This function is not yet implemented! Please raise an issue on Github!"
            ),
        }
    }
}
impl Error for FeagiDataError {}

//  TODO From<> from other error types