Struct tuig_iosys::XY

pub struct XY(pub usize, pub usize);

A position or size, with an X and a Y component.

You can do most arithmetic with XY that you could with integers, both elementwise with other XYs (e.g. XY(2, 3) * XY(4, 5) == XY(8, 15)) and with scalars (e.g. XY(2, 3) * 4 == XY(8, 12)).

XYs aren’t totally ordered because the components can be ordered differently, e.g. XY(1, 5) and XY(2, 3), the x is less but the y is greater. However, some methods (where it makes sense) are provided separately from Ord, and they operate elementwise, e.g. Self::clamp.

When used as a position, XY(0, 0) is at the top left of the screen, and XY(0, 1) is just below it – the usual “graphics axes”.

Tuple Fields

0: usize

1: usize

Implementations

impl XY

pub const fn x(&self) -> usize

The X component

Examples found in repository

examples/list-actions.rs (line 11)

fn list_events(mut sys: Box<dyn IoSystem>) {
    let mut log = vec!["press escape to exit when you're done".to_owned()];
    let mut screen = Screen::new(sys.size());
    loop {
        screen.resize(sys.size());
        for (line, row) in log.iter().rev().zip((0..screen.size().y()).rev()) {
            for (char, col) in line.chars().zip(0..screen.size().x()) {
                screen[row][col] = Cell::of(char);
            }
        }
        sys.draw(&screen).expect("failed to render screen");
        match sys.input().expect("failed to get input") {
            Action::Closed | Action::KeyPress { key: Key::Escape } => break,
            Action::Error(e) => panic!("{1}: {:?}", e, "got an error for input"),
            other => log.push(format!("{:?}", other)),
        }
        if log.len() > screen.size().y() {
            let diff = log.len() - screen.size().y();
            log.drain(..diff);
        }
    }
    sys.stop();
}

examples/color-demo.rs (line 48)

fn color_demo(mut sys: Box<dyn IoSystem>) {
    let color_width = Color::all()
        .into_iter()
        .map(|c| format!("{:?}", c).len())
        .max()
        .unwrap();

    let mut lines: Vec<Vec<Cell>> = Color::all()
        .into_iter()
        .map(|bg| {
            let mut line = vec![];
            for fg in Color::all() {
                let text = format!("{:?} on {1:<2$} ", fg, format!("{:?}", bg), color_width);
                line.extend(text.chars().map(move |c| Cell::of(c).fg(fg).bg(bg)));
            }
            line
        })
        .collect();
    let width: usize = lines.iter().map(|l| l.len()).max().unwrap() + 5;
    for line in &mut lines {
        let bg = line[0].get_fmt().bg;
        line.extend(repeat(Cell::of(' ').bg(bg)).take(width - line.len()));
    }
    let mut screen = Screen::new(XY(0, 0));
    let mut pos = 0;
    let mut moving = true;
    'main: loop {
        while let Some(action) = sys.poll_input().unwrap() {
            match action {
                Action::Closed | Action::KeyPress { key: Key::Escape } => break 'main,
                Action::KeyPress {
                    key: Key::Char(' '),
                } => moving = !moving,
                _ => (),
            }
        }
        if moving || sys.size() != screen.size() {
            screen.resize(sys.size());
            for row in 0..screen.size().y() {
                let o_row = (row + pos) % lines.len();
                for col in 0..screen.size().x() {
                    let o_col = (col + pos * 3) % width;
                    screen[row][col] = lines[o_row][o_col].clone();
                }
            }
            sys.draw(&screen).expect("failed to render screen");
        }
        if moving {
            pos += 1;
            thread::sleep(Duration::from_millis(250));
        } else {
            thread::sleep(Duration::from_millis(50));
        }
    }
    sys.stop();
}

pub const fn y(&self) -> usize

The Y component

Examples found in repository

examples/list-actions.rs (line 10)

fn list_events(mut sys: Box<dyn IoSystem>) {
    let mut log = vec!["press escape to exit when you're done".to_owned()];
    let mut screen = Screen::new(sys.size());
    loop {
        screen.resize(sys.size());
        for (line, row) in log.iter().rev().zip((0..screen.size().y()).rev()) {
            for (char, col) in line.chars().zip(0..screen.size().x()) {
                screen[row][col] = Cell::of(char);
            }
        }
        sys.draw(&screen).expect("failed to render screen");
        match sys.input().expect("failed to get input") {
            Action::Closed | Action::KeyPress { key: Key::Escape } => break,
            Action::Error(e) => panic!("{1}: {:?}", e, "got an error for input"),
            other => log.push(format!("{:?}", other)),
        }
        if log.len() > screen.size().y() {
            let diff = log.len() - screen.size().y();
            log.drain(..diff);
        }
    }
    sys.stop();
}

examples/color-demo.rs (line 46)

fn color_demo(mut sys: Box<dyn IoSystem>) {
    let color_width = Color::all()
        .into_iter()
        .map(|c| format!("{:?}", c).len())
        .max()
        .unwrap();

    let mut lines: Vec<Vec<Cell>> = Color::all()
        .into_iter()
        .map(|bg| {
            let mut line = vec![];
            for fg in Color::all() {
                let text = format!("{:?} on {1:<2$} ", fg, format!("{:?}", bg), color_width);
                line.extend(text.chars().map(move |c| Cell::of(c).fg(fg).bg(bg)));
            }
            line
        })
        .collect();
    let width: usize = lines.iter().map(|l| l.len()).max().unwrap() + 5;
    for line in &mut lines {
        let bg = line[0].get_fmt().bg;
        line.extend(repeat(Cell::of(' ').bg(bg)).take(width - line.len()));
    }
    let mut screen = Screen::new(XY(0, 0));
    let mut pos = 0;
    let mut moving = true;
    'main: loop {
        while let Some(action) = sys.poll_input().unwrap() {
            match action {
                Action::Closed | Action::KeyPress { key: Key::Escape } => break 'main,
                Action::KeyPress {
                    key: Key::Char(' '),
                } => moving = !moving,
                _ => (),
            }
        }
        if moving || sys.size() != screen.size() {
            screen.resize(sys.size());
            for row in 0..screen.size().y() {
                let o_row = (row + pos) % lines.len();
                for col in 0..screen.size().x() {
                    let o_col = (col + pos * 3) % width;
                    screen[row][col] = lines[o_row][o_col].clone();
                }
            }
            sys.draw(&screen).expect("failed to render screen");
        }
        if moving {
            pos += 1;
            thread::sleep(Duration::from_millis(250));
        } else {
            thread::sleep(Duration::from_millis(50));
        }
    }
    sys.stop();
}

pub fn clamp(self, top_left: Self, bottom_right: Self) -> XY

Contain this XY within the given bounds, elementwise.

Trait Implementations

impl Add<(usize, usize)> for XY

type Output = XY

The resulting type after applying the + operator.

fn add(self, rhs: (usize, usize)) -> XY

Performs the + operation.

impl Add<usize> for XY

type Output = XY

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> XY

Performs the + operation.

impl Add for XY

type Output = XY

The resulting type after applying the + operator.

fn add(self, rhs: XY) -> XY

Performs the + operation.

impl AddAssign<(usize, usize)> for XY

fn add_assign(&mut self, rhs: (usize, usize))

Performs the += operation.

impl AddAssign for XY

fn add_assign(&mut self, rhs: XY)

Performs the += operation.

impl Clone for XY

fn clone(&self) -> XY

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for XY

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

Formats the value using the given formatter.

impl Display for XY

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

Formats the value using the given formatter.

impl Div<(usize, usize)> for XY

type Output = XY

The resulting type after applying the / operator.

fn div(self, rhs: (usize, usize)) -> XY

Performs the / operation.

impl Div<usize> for XY

type Output = XY

The resulting type after applying the / operator.

fn div(self, rhs: usize) -> XY

Performs the / operation.

impl Div for XY

type Output = XY

The resulting type after applying the / operator.

fn div(self, rhs: XY) -> XY

Performs the / operation.

impl DivAssign<(usize, usize)> for XY

fn div_assign(&mut self, rhs: (usize, usize))

Performs the /= operation.

impl DivAssign for XY

fn div_assign(&mut self, rhs: XY)

Performs the /= operation.

impl From<(usize, usize)> for XY

fn from(f: (usize, usize)) -> XY

Converts to this type from the input type.

impl From<XY> for (usize, usize)

fn from(val: XY) -> Self

Converts to this type from the input type.

impl Mul<(usize, usize)> for XY

type Output = XY

The resulting type after applying the * operator.

fn mul(self, rhs: (usize, usize)) -> XY

Performs the * operation.

impl Mul<usize> for XY

type Output = XY

The resulting type after applying the * operator.

fn mul(self, rhs: usize) -> XY

Performs the * operation.

impl Mul for XY

type Output = XY

The resulting type after applying the * operator.

fn mul(self, rhs: XY) -> XY

Performs the * operation.

impl MulAssign<(usize, usize)> for XY

fn mul_assign(&mut self, rhs: (usize, usize))

Performs the *= operation.

impl MulAssign for XY

fn mul_assign(&mut self, rhs: XY)

Performs the *= operation.

impl PartialEq for XY

fn eq(&self, other: &XY) -> 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 XY

fn partial_cmp(&self, other: &Self) -> 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 Rem<(usize, usize)> for XY

type Output = XY

The resulting type after applying the % operator.

fn rem(self, rhs: (usize, usize)) -> XY

Performs the % operation.

impl Rem<usize> for XY

type Output = XY

The resulting type after applying the % operator.

fn rem(self, rhs: usize) -> XY

Performs the % operation.

impl Rem for XY

type Output = XY

The resulting type after applying the % operator.

fn rem(self, rhs: XY) -> XY

Performs the % operation.

impl RemAssign<(usize, usize)> for XY

fn rem_assign(&mut self, rhs: (usize, usize))

Performs the %= operation.

impl RemAssign for XY

fn rem_assign(&mut self, rhs: XY)

Performs the %= operation.

impl Sub<(usize, usize)> for XY

type Output = XY

The resulting type after applying the - operator.

fn sub(self, rhs: (usize, usize)) -> XY

Performs the - operation.

impl Sub<usize> for XY

type Output = XY

The resulting type after applying the - operator.

fn sub(self, rhs: usize) -> XY

Performs the - operation.

impl Sub for XY

type Output = XY

The resulting type after applying the - operator.

fn sub(self, rhs: XY) -> XY

Performs the - operation.

impl SubAssign<(usize, usize)> for XY

fn sub_assign(&mut self, rhs: (usize, usize))

Performs the -= operation.

impl SubAssign for XY

fn sub_assign(&mut self, rhs: XY)

Performs the -= operation.

impl Copy for XY

impl Eq for XY

impl StructuralEq for XY

impl StructuralPartialEq for XY