Struct UnitsError 

pub struct UnitsError {
    pub code: c_int,
}

UnitsError wraps a raw error code returned by the GNU units C library.

Every fallible operation in this crate returns Result<T>, which resolves to Err(UnitsError) when the underlying C function signals failure. Inspect code against the E_* constants re-exported from gnu_units_sys to identify the specific error kind.

Examples

use gnu_units::Unit;

match Unit::parse(")") {
    Ok(_) => {}
    Err(e) => println!("parse failed: {e}"),
}

Fields

code: c_int

Raw error code from the GNU units C library.

Compare against the E_* constants exported by gnu_units_sys (e.g. gnu_units_sys::E_PARSE, gnu_units_sys::E_BADSUM) to identify the failure mode.

Implementations

impl UnitsError

pub fn is_not_dimensionless(&self) -> bool

Returns true when the error indicates that a unit is not dimensionless (it still carries base dimensions after reduction).

This error typically arises in two scenarios:

• A failed Unit::convert_to where the source and target have incompatible dimensions (conformability mismatch).
• A Unit::to_number call on a unit that still has dimensions.

pub fn is_invalid_unit(&self) -> bool

Returns true when the error indicates that the input could not be resolved to a valid unit, either because parsing failed (E_PARSE) or because the unit name is not in the database (E_UNKNOWNUNIT).

Trait Implementations

impl Clone for UnitsError

fn clone(&self) -> UnitsError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnitsError

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

Formats the value using the given formatter.

impl Display for UnitsError

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

Formats the error as "GNU units error code <N>".

<N> is the raw integer value of UnitsError::code; compare it against the E_* constants in gnu_units_sys to identify the specific failure mode.

impl Error for UnitsError

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 PartialEq for UnitsError

fn eq(&self, other: &UnitsError) -> 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 UnitsError

impl Eq for UnitsError

impl StructuralPartialEq for UnitsError