Enum Error 

pub enum Error {
    InvalidCurve,
    NumericalError,
    InvalidTemperature,
}

Errors that can occur during battery SOC estimation

This enum represents all possible error conditions that may arise when using the battery estimator library.

Examples

use battery_estimator::{BatteryChemistry, SocEstimator, Error};

let estimator = SocEstimator::new(BatteryChemistry::LiPo);

match estimator.estimate_soc(3.7) {
    Ok(soc) => println!("SOC: {:.1}%", soc),
    Err(Error::InvalidCurve) => eprintln!("Invalid battery curve"),
    Err(Error::NumericalError) => eprintln!("Calculation error"),
    Err(Error::InvalidTemperature) => eprintln!("Invalid temperature"),
}

Variants

InvalidCurve

The voltage curve data is invalid

This error occurs when:

• The curve has fewer than 2 points (cannot interpolate)
• The curve points are not properly ordered
• The curve has duplicate voltage values

Examples

use battery_estimator::{Curve, CurvePoint, Error};

// Invalid: Only one point
let invalid_curve = Curve::new(&[CurvePoint::new(3.7, 50.0)]);
let result = invalid_curve.voltage_to_soc(3.7);
assert!(matches!(result, Err(Error::InvalidCurve)));

NumericalError

A numerical error occurred during calculation

This error occurs when:

• Division by zero in interpolation
• Overflow or underflow in calculations
• Invalid floating-point operations

Examples

use battery_estimator::{Curve, CurvePoint, Error};

// This could occur if curve points have the same voltage
let problematic_curve = Curve::new(&[
    CurvePoint::new(3.7, 50.0),
    CurvePoint::new(3.7, 60.0), // Duplicate voltage!
]);

InvalidTemperature

The temperature value is invalid

This error occurs when:

• Temperature is NaN (Not a Number)
• Temperature is infinity
• Temperature is outside reasonable bounds

Examples

use battery_estimator::{BatteryChemistry, SocEstimator, Error};

let estimator = SocEstimator::new(BatteryChemistry::LiPo);

// Invalid temperature
let result = estimator.estimate_soc_with_temp(3.7, f32::NAN);

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Error

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Error

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl Hash for Error

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Error

fn eq(&self, other: &Error) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Error

impl Eq for Error

impl StructuralPartialEq for Error