pub struct Length {
pub value: f64,
pub unit: Unit,
}
Expand description
A physical length, described by a value and a Unit
.
A Length
can be created with Length::new
, by multiplying a float with a Unit
, or
using the shorthand constructors:
assert_eq!(Length::new(0.0356, Unit::Cm), 0.0356 * Unit::Cm);
assert_eq!(Length::new(0.0356, Unit::Cm), Length::cm(0.0356));
All float conversion assume the default Unit
of Unit::Px
:
assert_eq!(Length::from(96.0), Length::new(96., Unit::Px));
assert_eq!(f64::from(1.0 * Unit::In), 96.0);
The usual arithmetic operations are supported.
Note: Floats are always considered as Unit::Px
. When adding or subtracting two
Length
s, the result will have the Unit
of the left-hand side.
// Negation is supported.
assert_eq!(-Length::new(1.0, Unit::In), -1.0 * Unit::In);
// The result has the unit of the left-hand side.
assert_eq!(1.0 * Unit::In + 2.54 * Unit::Cm, 2.0 * Unit::In);
assert_eq!(5.08 * Unit::Cm - 1.0 * Unit::In, 2.54 * Unit::Cm);
// Floats are considered pixels.
assert_eq!(1.0 * Unit::In + 96.0, 2.0 * Unit::In);
assert_eq!(96.0 + 1.0 * Unit::In , 2.0 * Unit::In);
assert_eq!(2.0 * Unit::In - 96.0, 1.0 * Unit::In);
assert_eq!(96.0 - 0.5 * Unit::In, 0.5 * Unit::In);
// Multiplication and division by floats is supported.
// Note: dividing by a `Length` is not supported.
assert_eq!((1.0 * Unit::In) * 2.0, 2.0 * Unit::In);
assert_eq!(2.0 * (1.0 * Unit::In), 2.0 * Unit::In);
assert_eq!((1.0 * Unit::In) / 2.0, 0.5 * Unit::In);
Length
implements From
for Unit
, so you can use Unit
as a shorthand:
assert_eq!(Length::from(Unit::In), Length::new(1., Unit::In));
A Length
with a different Unit
can be converted using Length::convert_to
:
let l = Length::new(2.54, Unit::Cm);
assert_eq!(l.convert_to(Unit::In), 1.0 * Unit::In);
Length
delegates Display
to f64
, so it supports the standard float formatting
syntax:
let l = Length::new(0.0356, vsvg::Unit::Cm);
assert_eq!(format!("{l:.2}"), "0.04cm");
Fields§
§value: f64
§unit: Unit
Implementations§
source§impl Length
impl Length
sourcepub fn pixels<F: Float + AsPrimitive<f64>>(value: F) -> Self
pub fn pixels<F: Float + AsPrimitive<f64>>(value: F) -> Self
sourcepub fn inches<F: Float + AsPrimitive<f64>>(value: F) -> Self
pub fn inches<F: Float + AsPrimitive<f64>>(value: F) -> Self
sourcepub fn feet<F: Float + AsPrimitive<f64>>(value: F) -> Self
pub fn feet<F: Float + AsPrimitive<f64>>(value: F) -> Self
sourcepub fn yards<F: Float + AsPrimitive<f64>>(value: F) -> Self
pub fn yards<F: Float + AsPrimitive<f64>>(value: F) -> Self
sourcepub fn miles<F: Float + AsPrimitive<f64>>(value: F) -> Self
pub fn miles<F: Float + AsPrimitive<f64>>(value: F) -> Self
sourcepub fn mm<F: Float + AsPrimitive<f64>>(value: F) -> Self
pub fn mm<F: Float + AsPrimitive<f64>>(value: F) -> Self
sourcepub fn cm<F: Float + AsPrimitive<f64>>(value: F) -> Self
pub fn cm<F: Float + AsPrimitive<f64>>(value: F) -> Self
sourcepub fn meters<F: Float + AsPrimitive<f64>>(value: F) -> Self
pub fn meters<F: Float + AsPrimitive<f64>>(value: F) -> Self
sourcepub fn km<F: Float + AsPrimitive<f64>>(value: F) -> Self
pub fn km<F: Float + AsPrimitive<f64>>(value: F) -> Self
sourcepub fn picas<F: Float + AsPrimitive<f64>>(value: F) -> Self
pub fn picas<F: Float + AsPrimitive<f64>>(value: F) -> Self
sourcepub fn points<F: Float + AsPrimitive<f64>>(value: F) -> Self
pub fn points<F: Float + AsPrimitive<f64>>(value: F) -> Self
Trait Implementations§
source§impl<'de> Deserialize<'de> for Length
impl<'de> Deserialize<'de> for Length
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§impl PartialOrd for Length
impl PartialOrd for Length
source§impl SampleUniform for Length
impl SampleUniform for Length
source§type Sampler = LengthSampler
type Sampler = LengthSampler
The
UniformSampler
implementation supporting type X
.impl Copy for Length
impl StructuralPartialEq for Length
Auto Trait Implementations§
impl Freeze for Length
impl RefUnwindSafe for Length
impl Send for Length
impl Sync for Length
impl Unpin for Length
impl UnwindSafe for Length
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)source§impl<T> FmtForward for T
impl<T> FmtForward for T
source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self
to use its Binary
implementation when Debug
-formatted.source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self
to use its Display
implementation when
Debug
-formatted.source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self
to use its LowerExp
implementation when
Debug
-formatted.source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self
to use its LowerHex
implementation when
Debug
-formatted.source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self
to use its Octal
implementation when Debug
-formatted.source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self
to use its Pointer
implementation when
Debug
-formatted.source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self
to use its UpperExp
implementation when
Debug
-formatted.source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self
to use its UpperHex
implementation when
Debug
-formatted.source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moresource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self
and passes that borrow into the pipe function. Read moresource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self
and passes that borrow into the pipe function. Read moresource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self
, then passes self.as_ref()
into the pipe function.source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self
, then passes self.as_mut()
into the pipe
function.source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self
, then passes self.deref()
into the pipe function.source§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<Borrowed> SampleBorrow<Borrowed> for Borrowedwhere
Borrowed: SampleUniform,
impl<Borrowed> SampleBorrow<Borrowed> for Borrowedwhere
Borrowed: SampleUniform,
source§fn borrow(&self) -> &Borrowed
fn borrow(&self) -> &Borrowed
Immutably borrows from an owned value. See
Borrow::borrow
source§impl<T> Tap for T
impl<T> Tap for T
source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B>
of a value. Read moresource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B>
of a value. Read moresource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R>
view of a value. Read moresource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R>
view of a value. Read moresource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target
of a value. Read moresource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target
of a value. Read moresource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap()
only in debug builds, and is erased in release builds.source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref()
only in debug builds, and is erased in release
builds.source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut()
only in debug builds, and is erased in release
builds.source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref()
only in debug builds, and is erased in release
builds.