Struct cursive::XY

pub struct XY<T> {
    pub x: T,
    pub y: T,
}

A generic structure with a value for each axis.

Fields

x: T

X-axis value

y: T

Y-axis value

Methods

impl XY<usize>

fn saturating_sub<O: Into<Self>>(&self, other: O) -> Self

Saturating subtraction. Computes self - other, saturating at 0.

Never panics.

fn checked_sub<O: Into<Self>>(&self, other: O) -> Option<Self>

Checked subtraction. Computes self - other if possible.

Returns None if self.x < other.x || self.y < other.y.

Never panics.

fn signed(self) -> XY<isize>

Returns a XY<isize> from self.

impl<T: Ord> XY<T>

fn fits_in<O: Into<Self>>(&self, other: O) -> bool

Returns true if self could fit inside other.

Shortcut for self.x <= other.x && self.y <= other.y.

If this returns true, then other - self will not underflow.

fn fits<O: Into<Self>>(&self, other: O) -> bool

Returns true if other could fit inside self.

Shortcut for self.x >= other.x && self.y >= other.y.

If this returns true, then self - other will not underflow.

fn max<A: Into<XY<T>>, B: Into<XY<T>>>(a: A, b: B) -> Self

Returns a new Vec2 that is a maximum per coordinate.

fn min<A: Into<XY<T>>, B: Into<XY<T>>>(a: A, b: B) -> Self

Returns a new Vec2 that is no larger than any input in both dimensions.

fn or_min<O: Into<XY<T>>>(self, other: O) -> Self

Returns the minimum of self and other.

fn or_max<O: Into<XY<T>>>(self, other: O) -> Self

Returns the maximum of self and other.

impl<T: Ord + Add<Output = T> + Clone> XY<T>

fn stack_vertical(&self, other: &Self) -> Self

Returns (max(self.x,other.x), self.y+other.y)

fn stack_horizontal(&self, other: &Self) -> Self

Returns (self.x+other.x, max(self.y,other.y))

fn fits_in_rect<O1, O2>(&self, top_left: O1, size: O2) -> bool where
    O1: Into<Self>,
    O2: Into<Self>, 

Returns true if self fits in the given rectangle.

impl<T: Zero + Clone> XY<T>

fn keep_x(&self) -> Self

Returns a vector with the X component of self, and y=0.

fn keep_y(&self) -> Self

Returns a vector with the Y component of self, and x=0.

fn zero() -> Self

Alias for Self::new(0,0).

impl<T> XY<T>

fn new(x: T, y: T) -> Self

Creates a new XY from the given values.

fn map<U, F: Fn(T) -> U>(self, f: F) -> XY<U>

Creates a new XY by applying f to x and y.

fn map_x<F: Fn(T) -> T>(self, f: F) -> Self

Creates a new XY by applying f to x, and carrying y over.

fn map_y<F: Fn(T) -> T>(self, f: F) -> Self

Creates a new XY by applying f to y, and carrying x over.

fn pair(self) -> (T, T)

Destructure self into a pair.

fn as_ref(&self) -> XY<&T>

Return a XY with references to this one's values.

fn iter(&self) -> Chain<Once<&T>, Once<&T>>

Creates an iterator that returns references to x, then y.

fn get(&self, o: Orientation) -> &T

Returns a reference to the value on the given axis.

fn get_mut(&mut self, o: Orientation) -> &mut T

Returns a mutable reference to the value on the given axis.

fn zip<U>(self, other: XY<U>) -> XY<(T, U)>

Returns a new XY of tuples made by zipping self and other.

fn zip_map<U, V, F: Fn(T, U) -> V>(self, other: XY<U>, f: F) -> XY<V>

Returns a new XY by calling f on self and other for each axis.

impl<T: Clone> XY<T>

fn with_axis(&self, o: Orientation, value: T) -> Self

Returns a new XY with the axis o set to value.

fn with_axis_from(&self, o: Orientation, other: &Self) -> Self

Returns a new XY with the axis o set to the value from other.

fn set_axis_from(&mut self, o: Orientation, other: &Self)

Sets the axis o on self to the value from other.

impl<T> XY<Option<T>>

fn unwrap_or(self, other: XY<T>) -> XY<T>

Returns a new XY by calling unwrap_or on each axis.

impl XY<bool>

fn any(&self) -> bool

Returns true if any of x or y is true.

fn both(&self) -> bool

Returns true if both x and y are true.

impl<T: Copy> XY<T>

fn both_from(value: T) -> Self

Creates a XY with both x and y set to value.

Trait Implementations

impl<T: PartialOrd> PartialOrd for XY<T>

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

a < b <=> a.x < b.x && a.y < b.y

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<T: Into<XY<usize>>> From<T> for XY<isize>

fn from(t: T) -> Self

Performs the conversion.

impl From<(i32, i32)> for XY<usize>

fn from((x, y): (i32, i32)) -> Self

Performs the conversion.

impl From<(u32, u32)> for XY<usize>

fn from((x, y): (u32, u32)) -> Self

Performs the conversion.

impl From<(u8, u8)> for XY<usize>

fn from((x, y): (u8, u8)) -> Self

Performs the conversion.

impl From<(u16, u16)> for XY<usize>

fn from((x, y): (u16, u16)) -> Self

Performs the conversion.

impl<T: Add<Output = T>, O: Into<XY<T>>> Add<O> for XY<T>

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: O) -> Self

Performs the + operation.

impl<T: Sub<Output = T>, O: Into<XY<T>>> Sub<O> for XY<T>

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: O) -> Self

Performs the - operation.

impl<T: Clone + Div<Output = T>> Div<T> for XY<T>

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: T) -> Self

Performs the / operation.

impl Mul<usize> for XY<usize>

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, other: usize) -> Vec2

Performs the * operation.

impl<T: Debug> Debug for XY<T>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T: Clone> Clone for XY<T>

fn clone(&self) -> XY<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for XY<T>

impl<T: PartialEq> PartialEq for XY<T>

fn eq(&self, __arg_0: &XY<T>) -> bool

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

fn ne(&self, __arg_0: &XY<T>) -> bool

This method tests for !=.

impl<T: Eq> Eq for XY<T>

impl<T: Hash> Hash for XY<T>

fn hash<__HT: Hasher>(&self, __arg_0: &mut __HT)

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl<T> From<(T, T)> for XY<T>

fn from((x, y): (T, T)) -> Self

Performs the conversion.