Struct rsass::value::Numeric

pub struct Numeric {
    pub value: Number,
    pub unit: UnitSet,
}

A Numeric value is a Number with a Unit (which may be Unit::None).

Fields

value: Number

The number value of this numeric.

unit: UnitSet

The unit of this numeric.

Implementations

impl Numeric

pub fn new<V: Into<Number>, U: Into<UnitSet>>(value: V, unit: U) -> Self

Create a new numeric value.

The value can be given as anything that can be converted into a Number, e.g. an isize, a Rational, or a f64.

pub fn scalar(value: impl Into<Number>) -> Numeric

Create a new numeric value with no unit.

pub fn as_unit(&self, unit: Unit) -> Option<Number>

Convert this numeric value to a given unit, if possible.

Examples

let inch = Numeric::new(1, Unit::In);
assert_eq!(inch.as_unit(Unit::Mm).unwrap() * 5, 127.into());
assert_eq!(inch.as_unit(Unit::Deg), None);

pub fn as_unitset(&self, unit: &UnitSet) -> Option<Number>

Convert this numeric value to a given unit, if possible.

Examples

let inch = Numeric::new(1, Unit::In);
assert_eq!(inch.as_unit(Unit::Mm).unwrap() * 5, 127.into());
assert_eq!(inch.as_unit(Unit::Deg), None);

pub fn as_unit_def(&self, unit: Unit) -> Option<Number>

Convert this numeric value to a given unit, if possible.

Like as_unit, except a unitless numeric is considered to be the expected unit.

pub fn as_ratio(&self) -> Result<Rational, BadNumber>

Get this number as a rational number.

The unit is ignored. If the value is bignum rational or floating point, it is approximated as long as it is withing range, otherwises an error is returned.

pub fn is_no_unit(&self) -> bool

Return true if this value has no unit.

pub fn format(&self, format: Format) -> Formatted<'_, Numeric>

Get a reference to this Value bound to an output format.

Trait Implementations

impl Clone for Numeric

fn clone(&self) -> Numeric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Numeric

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

Formats the value using the given formatter.

impl Div for &Numeric

type Output = Numeric

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl From<Numeric> for Value

fn from(num: Numeric) -> Self

Converts to this type from the input type.

impl From<Numeric> for Value

fn from(v: Numeric) -> Value

Converts to this type from the input type.

impl Mul for &Numeric

type Output = Numeric

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl Neg for &Numeric

type Output = Numeric

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for Numeric

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Numeric

fn partial_cmp(&self, other: &Numeric) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<Value> for Numeric

type Error = IsNot

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Numeric

impl StructuralEq for Numeric