Struct Unit 

pub struct Unit { /* private fields */ }

Represents a dimensional quantity: a numeric factor paired with zero or more base dimensions.

Implementations

impl Unit

pub fn new() -> Self

Creates a freshly initialised unit with factor 1.0 and no dimensions.

pub fn parse(input: &str) -> Result<Self>

Parses a GNU units expression string and returns the resulting Unit.

pub fn factor(&self) -> f64

Returns the numeric factor of the unit.

pub fn base_units(&self) -> String

Returns the base dimensions as a human-readable string.

pub fn multiply(&mut self, rhs: Unit) -> Result<()>

Multiplies self by rhs in place.

pub fn divide(&mut self, rhs: Unit) -> Result<()>

Divides self by rhs in place.

pub fn add(&mut self, rhs: Unit) -> Result<()>

Adds rhs to self in place.

pub fn invert(&mut self)

Inverts self in place (reciprocal).

pub fn pow(&mut self, power: i32) -> Result<()>

Raises self to a non-negative integer power in place.

pub fn root(&mut self, n: i32) -> Result<()>

Takes the n-th root of self in place.

pub fn to_number(&self) -> Result<f64>

Converts a dimensionless unit to its numeric value.

pub fn convert_to(self, to: Unit) -> Result<f64>

Converts self into the unit expressed by to, returning the numeric conversion factor.

pub fn is_conformable(&self, other: &Unit) -> bool

Returns true when self and other have the same base dimensions.

Trait Implementations

impl Clone for Unit

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Unit

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Unit

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.