pub struct Dims { /* private fields */ }
Expand description

A horizontal and vertical rectangular dimension with no specified location.

Implementations§

source§

impl Dims

source

pub fn new(w: i64, h: i64) -> Dims

Creates a new Dims from a width and height.

source

pub fn square(value: i64) -> Dims

Creates a new Dims with width and height equal to value.

§Example
assert_eq!(Dims::square(100), Dims::new(100, 100));
source

pub fn dim(&self, dir: Dir) -> i64

Returns the dimension in the specified direction.

§Example
let dims = Dims::new(100, 200);
assert_eq!(dims.dim(Dir::Vert), 200);
assert_eq!(dims.dim(Dir::Horiz), 100);
source

pub fn longer_dir(&self) -> Dir

Returns the direction of the longer dimension.

If the width and height are equal, returns Dir::Horiz.

§Example
let dims = Dims::new(100, 200);
assert_eq!(dims.longer_dir(), Dir::Vert);
let dims = Dims::new(200, 100);
assert_eq!(dims.longer_dir(), Dir::Horiz);
let dims = Dims::new(100, 100);
assert_eq!(dims.longer_dir(), Dir::Horiz);
source

pub fn longer_dir_strict(&self) -> Option<Dir>

Returns the direction of the longer dimension.

If the width and height are equal, returns None. Otherwise, returns a Some variant containing the longer direction.

source

pub fn transpose(self) -> Dims

Returns a new Dims object with the horizontal and vertical dimensions flipped.

source

pub fn width(&self) -> i64

Returns the width (i.e. the horizontal dimension).

source

pub fn height(&self) -> i64

Returns the height (i.e. the vertical dimension).

source

pub fn w(&self) -> i64

Returns the width (i.e. the horizontal dimension).

A shorthand for Dims::width.

source

pub fn h(&self) -> i64

Returns the height (i.e. the vertical dimension).

A shorthand for Dims::height.

source

pub fn into_rect(self) -> Rect

Converts this dimension object into a Rect.

See Rect::from_dims for more information.

source

pub fn into_point(self) -> Point

Converts this dimension object into a Point with coordinates (self.w(), self.h()).

Trait Implementations§

source§

impl Add<Dims> for Point

§

type Output = Point

The resulting type after applying the + operator.
source§

fn add(self, rhs: Dims) -> <Point as Add<Dims>>::Output

Performs the + operation. Read more
source§

impl Add for Dims

§

type Output = Dims

The resulting type after applying the + operator.
source§

fn add(self, rhs: Dims) -> <Dims as Add>::Output

Performs the + operation. Read more
source§

impl AddAssign<Dims> for Point

source§

fn add_assign(&mut self, rhs: Dims)

Performs the += operation. Read more
source§

impl AddAssign for Dims

source§

fn add_assign(&mut self, rhs: Dims)

Performs the += operation. Read more
source§

impl Clone for Dims

source§

fn clone(&self) -> Dims

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Dims

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Dims

source§

fn default() -> Dims

Returns the “default value” for a type. Read more
source§

impl<'de> Deserialize<'de> for Dims

source§

fn deserialize<__D>( __deserializer: __D ) -> Result<Dims, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl From<Dims> for Rect

source§

fn from(value: Dims) -> Rect

Converts the Dims to a Rect as described in Rect::from_dims.

source§

impl From<Point> for Dims

source§

fn from(value: Point) -> Dims

Create a new dimension object from a point.

The width field of the resulting Dims will be the point’s x-coordinate. The height field of the resulting Dims will be the point’s y-coordinate.

source§

impl From<Rect> for Dims

source§

fn from(value: Rect) -> Dims

Obtains Dims from the given Rect using Rect::dims.

source§

impl Hash for Dims

source§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl Mul<(usize, usize)> for Dims

§

type Output = Dims

The resulting type after applying the * operator.
source§

fn mul(self, rhs: (usize, usize)) -> <Dims as Mul<(usize, usize)>>::Output

Performs the * operation. Read more
source§

impl Mul<Dims> for Point

source§

fn mul(self, rhs: Dims) -> <Point as Mul<Dims>>::Output

Multiplies the x-coordinate of the point by the dimension’s width, and the y-coordinate of the point by the dimension’s height.

§

type Output = Point

The resulting type after applying the * operator.
source§

impl Mul<i64> for Dims

§

type Output = Dims

The resulting type after applying the * operator.
source§

fn mul(self, rhs: i64) -> <Dims as Mul<i64>>::Output

Performs the * operation. Read more
source§

impl MulAssign<i64> for Dims

source§

fn mul_assign(&mut self, rhs: i64)

Performs the *= operation. Read more
source§

impl Ord for Dims

source§

fn cmp(&self, other: &Dims) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Dims

source§

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

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

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.
source§

impl PartialOrd for Dims

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Serialize for Dims

source§

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl Sub for Dims

§

type Output = Dims

The resulting type after applying the - operator.
source§

fn sub(self, rhs: Dims) -> <Dims as Sub>::Output

Performs the - operation. Read more
source§

impl SubAssign for Dims

source§

fn sub_assign(&mut self, rhs: Dims)

Performs the -= operation. Read more
source§

impl Copy for Dims

source§

impl Eq for Dims

source§

impl StructuralPartialEq for Dims

Auto Trait Implementations§

§

impl RefUnwindSafe for Dims

§

impl Send for Dims

§

impl Sync for Dims

§

impl Unpin for Dims

§

impl UnwindSafe for Dims

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
source§

impl<T, U> CustomHardwareType<Flipped<T>> for U

source§

fn from_layout_type(other: &Flipped<T>) -> U

Creates this layout type from another layout type.
source§

impl<T, U> CustomHardwareType<InOut<T>> for U

source§

fn from_layout_type(other: &InOut<T>) -> U

Creates this layout type from another layout type.
source§

impl<T, U> CustomHardwareType<Input<T>> for U

source§

fn from_layout_type(other: &Input<T>) -> U

Creates this layout type from another layout type.
source§

impl<T, U> CustomHardwareType<Output<T>> for U

source§

fn from_layout_type(other: &Output<T>) -> U

Creates this layout type from another layout type.
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> IntoRequest<T> for T

source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

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

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> Connect<&T> for T

source§

impl<T> Connect<T> for T

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

source§

impl<T> Primitive for T
where T: Clone + Send + Sync + Any,

source§

impl<T> Primitive for T