Type Definition saito_rust::Error

pub type Error = Box<dyn Error + Send + Sync>;

Error returned by most functions.

When writing a real application, one might want to consider a specialized error handling crate or defining an error type as an enum of causes. However, most time using a boxed std::error::Error is sufficient.

For performance reasons, boxing is avoided in any hot path. For example, in parse, a custom error enum is defined. This is because the error is hit and handled during normal execution when a partial frame is received on a socket. std::error::Error is implemented for parse::Error which allows it to be converted to Box<dyn std::error::Error>.