Back to Eqiora docs Skip to main content

Quantity

eqiora::quantity

Struct Quantity 

pub struct Quantity<S, D>
where
    S: Scalar,
    D: Dimension,
{ /* private fields */ }
Description

Statically dimensioned quantity — the only representation of physical values inside the platform (rule 1).

Implementations§

§

impl<S, D> Quantity<S, D>
where S: Scalar, D: Dimension,

Signature links:§QuantityScalarDimension

pub const fn from_scalar(value: S) -> Quantity<S, D>

Signature links:from_scalarQuantity

Wrap an explicitly typed scalar. Prefer Quantity::new for the default f64 representation. External data goes through DynQuantity::checked_cast instead.

pub fn value(self) -> S

Signature links:value

The raw scalar value in SI base units.

§

impl<D> Quantity<f64, D>
where D: Dimension,

Signature links:§Quantityf64Dimension

pub const fn new(value: f64) -> Quantity<f64, D>

Signature links:newf64Quantityf64

Wrap an f64 literal or trusted numerical value in a static dimension. This is intentionally the unqualified constructor so aliases such as Velocity::new(3.0) select the default scalar without an inference annotation.

pub fn into_dyn(self) -> DynQuantity

Signature links:into_dynDynQuantity

Demote into the dynamic layer. Always safe (rule 3).

§

impl<D> Quantity<f32, D>
where D: Dimension,

Signature links:§Quantityf32Dimension

pub const fn new_f32(value: f32) -> Quantity<f32, D>

Signature links:new_f32f32Quantityf32

Wrap an f32 literal or trusted numerical value.

pub fn into_dyn(self) -> DynQuantity

Signature links:into_dynDynQuantity

Demote into the dynamic layer (widening to f64). Always safe.

Trait Implementations§

§

impl<S, D> Add for Quantity<S, D>
where S: Scalar, D: Dimension,

Signature links:§AddQuantityScalarDimension
§

type Output = Quantity<S, D>

Signature links:§OutputQuantity
The resulting type after applying the + operator.
§

fn add(self, rhs: Quantity<S, D>) -> Quantity<S, D>

Signature links:§addQuantityQuantity
Performs the + operation. Read more
§

impl<S, D> Clone for Quantity<S, D>
where S: Scalar, D: Dimension,

Signature links:§CloneQuantityScalarDimension
§

fn clone(&self) -> Quantity<S, D>

Signature links:§cloneQuantity
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Signature links:unstableSource§clone_from
Performs copy-assignment from source. Read more
§

impl<S, D> Debug for Quantity<S, D>
where S: Scalar, D: Dimension,

Signature links:§DebugQuantityScalarDimension
§

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

Signature links:§fmtFormatterResult()Error
Formats the value using the given formatter. Read more
§

impl<S, D> Div<S> for Quantity<S, D>
where S: Scalar, D: Dimension,

Signature links:§DivQuantityScalarDimension
§

type Output = Quantity<S, D>

Signature links:§OutputQuantity
The resulting type after applying the / operator.
§

fn div(self, rhs: S) -> Quantity<S, D>

Signature links:§divQuantity
Performs the / operation. Read more
§

impl<D> From<Quantity<f64, D>> for DynQuantity
where D: Dimension,

Signature links:§FromQuantityf64DynQuantityDimension
§

fn from(q: Quantity<f64, D>) -> DynQuantity

Signature links:§fromQuantityf64DynQuantity
Converts to this type from the input type.
§

impl<S, D> Mul<S> for Quantity<S, D>
where S: Scalar, D: Dimension,

Scaling by a bare scalar preserves the dimension.

Signature links:§MulQuantityScalarDimension
§

type Output = Quantity<S, D>

Signature links:§OutputQuantity
The resulting type after applying the * operator.
§

fn mul(self, rhs: S) -> Quantity<S, D>

Signature links:§mulQuantity
Performs the * operation. Read more
§

impl<S, D> Neg for Quantity<S, D>
where S: Scalar, D: Dimension,

Signature links:§NegQuantityScalarDimension
§

type Output = Quantity<S, D>

Signature links:§OutputQuantity
The resulting type after applying the - operator.
§

fn neg(self) -> Quantity<S, D>

Signature links:§negQuantity
Performs the unary - operation. Read more
§

impl<S, D> PartialEq for Quantity<S, D>
where S: Scalar, D: Dimension,

Signature links:§PartialEqQuantityScalarDimension
§

fn eq(&self, other: &Quantity<S, D>) -> bool

Signature links:§eqQuantitybool
Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Signature links:unstableSource§ne&Rhsbool
Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl<S, D> PartialOrd for Quantity<S, D>
where S: Scalar, D: Dimension,

Signature links:§PartialOrdQuantityScalarDimension
§

fn partial_cmp(&self, other: &Quantity<S, D>) -> Option<Ordering>

Signature links:§partial_cmpQuantityOptionOrdering
This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Signature links:unstableSource§lt&Rhsbool
Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Signature links:unstableSource§le&Rhsbool
Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Signature links:unstableSource§gt&Rhsbool
Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Signature links:unstableSource§ge&Rhsbool
Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
§

impl<S, D> Sub for Quantity<S, D>
where S: Scalar, D: Dimension,

Signature links:§SubQuantityScalarDimension
§

type Output = Quantity<S, D>

Signature links:§OutputQuantity
The resulting type after applying the - operator.
§

fn sub(self, rhs: Quantity<S, D>) -> Quantity<S, D>

Signature links:§subQuantityQuantity
Performs the - operation. Read more
§

impl<S, D> Copy for Quantity<S, D>
where S: Scalar, D: Dimension,

Auto Trait Implementations§

§

impl<S, D> Freeze for Quantity<S, D>
where S: Freeze,

§

impl<S, D> RefUnwindSafe for Quantity<S, D>
where S: RefUnwindSafe,

§

impl<S, D> Send for Quantity<S, D>
where S: Send,

§

impl<S, D> Sync for Quantity<S, D>
where S: Sync,

§

impl<S, D> Unpin for Quantity<S, D>
where S: Unpin,

§

impl<S, D> UnsafeUnpin for Quantity<S, D>
where S: UnsafeUnpin,

§

impl<S, D> UnwindSafe for Quantity<S, D>
where S: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Signature links:Source§AnySized
Source§

fn type_id(&self) -> TypeId

Signature links:Source§type_idTypeId
Gets the TypeId of self. Read more
§

impl<Src, Scheme> ApproxFrom<Src, Scheme> for Src
where Scheme: ApproxScheme,

Signature links:§
§

type Err = NoError

Signature links:§
The error type produced by a failed conversion.
§

fn approx_from(src: Src) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>

Signature links:§Result
Convert the given value into an approximately equivalent representation.
§

impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Src
where Dst: ApproxFrom<Src, Scheme>, Scheme: ApproxScheme,

Signature links:§
§

type Err = <Dst as ApproxFrom<Src, Scheme>>::Err

Signature links:§
The error type produced by a failed conversion.
§

fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>

Signature links:§Result
Convert the subject into an approximately equivalent representation.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Signature links:Source§BorrowSized
Source§

fn borrow(&self) -> &T

Signature links:Source§borrow&T
Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Signature links:Source§BorrowMutSized
Source§

fn borrow_mut(&mut self) -> &mut T

Signature links:Source§borrow_mut&mut T
Mutably borrows from an owned value. Read more
§

impl<T> ByRef<T> for T

Signature links:§
§

fn by_ref(&self) -> &T

Source§

impl<T> CloneToUninit for T
where T: Clone,

Signature links:Source§CloneToUninitClone
Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

Signature links:Source§clone_to_uninit*mut u8
🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T, Dst> ConvAsUtil<Dst> for T

Signature links:§
§

fn approx(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst>,

Signature links:§ResultSized
Approximate the subject with the default scheme.
§

fn approx_by<Scheme>(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst, Scheme>, Scheme: ApproxScheme,

Signature links:§ResultSized
Approximate the subject with a specific scheme.
§

impl<T> ConvUtil for T

Signature links:§
§

fn approx_as<Dst>(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst>,

Signature links:§ResultSized
Approximate the subject to a given type with the default scheme.
§

fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst, Scheme>, Scheme: ApproxScheme,

Signature links:§ResultSized
Approximate the subject to a given type with a specific scheme.
§

fn into_as<Dst>(self) -> Dst
where Self: Sized + Into<Dst>,

Signature links:§SizedInto
Convert the subject to a given type.
§

fn try_as<Dst>(self) -> Result<Dst, Self::Err>
where Self: Sized + TryInto<Dst>,

Signature links:§ResultSized
Attempt to convert the subject to a given type.
§

fn value_as<Dst>(self) -> Result<Dst, Self::Err>
where Self: Sized + ValueInto<Dst>,

Signature links:§ResultSized
Attempt a value conversion of the subject to a given type.
§

impl<T> DistributionExt for T
where T: ?Sized,

Signature links:§Sized
§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Signature links:Source§From
Source§

fn from(t: T) -> T

Signature links:Source§from

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Signature links:Source§IntoFrom
Source§

fn into(self) -> U

Signature links:Source§into

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Signature links:Source§IntoEither
Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Signature links:Source§into_eitherboolEither
Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Signature links:Source§into_either_withEitherFnOncebool
Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

Signature links:§
§

const ALIGN: usize

Signature links:§usize
The alignment of pointer.
§

type Init = T

Signature links:§
The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Signature links:§usize
Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Signature links:§usize&'a T
Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Signature links:§usize&'a mut T
Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Signature links:§usize
Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Signature links:Source§Same
Source§

type Output = T

Signature links:Source§Output
Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Signature links:§
§

fn to_subset(&self) -> Option<SS>

Signature links:§Option
The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Signature links:§bool
Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Signature links:§
Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

Signature links:§&SS
The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Signature links:Source§ToOwnedClone
Source§

type Owned = T

Signature links:Source§Owned
The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Signature links:Source§to_owned
Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Signature links:Source§clone_into&mut T
Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<Src> TryFrom<Src> for Src

Signature links:§
§

type Err = NoError

Signature links:§
The error type produced by a failed conversion.
§

fn try_from(src: Src) -> Result<Src, <Src as TryFrom<Src>>::Err>

Signature links:§Result
Convert the given value into the subject type.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Signature links:Source§TryFromInto
Source§

type Error = Infallible

Signature links:Source§ErrorInfallible
The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Signature links:Source§try_fromResultTryFromError
Performs the conversion.
§

impl<Src, Dst> TryInto<Dst> for Src
where Dst: TryFrom<Src>,

Signature links:§
§

type Err = <Dst as TryFrom<Src>>::Err

Signature links:§
The error type produced by a failed conversion.
§

fn try_into(self) -> Result<Dst, <Src as TryInto<Dst>>::Err>

Signature links:§Result
Convert the subject into the destination type.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Signature links:Source§TryIntoTryFrom
Source§

type Error = <U as TryFrom<T>>::Error

Signature links:Source§ErrorTryFromError
The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Signature links:Source§try_intoResultTryFromError
Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Signature links:§
§

fn vzip(self) -> V

§

impl<Src> ValueFrom<Src> for Src

Signature links:§
§

type Err = NoError

Signature links:§
The error type produced by a failed conversion.
§

fn value_from(src: Src) -> Result<Src, <Src as ValueFrom<Src>>::Err>

Signature links:§Result
Convert the given value into an exactly equivalent representation.
§

impl<Src, Dst> ValueInto<Dst> for Src
where Dst: ValueFrom<Src>,

Signature links:§
§

type Err = <Dst as ValueFrom<Src>>::Err

Signature links:§
The error type produced by a failed conversion.
§

fn value_into(self) -> Result<Dst, <Src as ValueInto<Dst>>::Err>

Signature links:§Result
Convert the subject into an exactly equivalent representation.
§

impl<T> Boilerplate for T
where T: Copy + Send + Sync + Debug + PartialEq + 'static,

§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> ClosedNeg for T
where T: Neg<Output = T>,

§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,