Struct lighthouse_protocol::Rect

pub struct Rect {
    pub origin: Pos,
    pub size: Delta,
}

A rectangle on the integer grid.

Fields

origin: Pos

size: Delta

Implementations

impl Rect

pub const fn new(origin: Pos, size: Delta) -> Self

Creates a new rectangle.

pub const fn x_range(self) -> Range<i32>

The range of x values.

pub const fn y_range(self) -> Range<i32>

The range of y values.

pub const fn contains(self, pos: Pos) -> bool

Checks whether the rectangle contains the given position.

pub fn index_of(self, pos: Pos) -> usize

Converts a position to an index.

pub const fn is_empty(self) -> bool

Whether this rectangle is empty.

pub fn sample_random_with(self, rng: &mut impl Rng) -> Option<Pos>

Samples a random position within the rectangle with the given rng.

pub fn sample_random(self) -> Option<Pos>

Samples a random position within the rectangle.

pub const fn width(self) -> i32

The rectangle’s width.

pub const fn height(self) -> i32

The rectangle’s height.

pub const fn area(self) -> i32

The rectangle’s area.

pub const fn wrap(self, pos: Pos) -> Pos

Wraps a value to the rectangle’s bounds.

Trait Implementations

impl Clone for Rect

fn clone(&self) -> Rect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Rect

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

Formats the value using the given formatter.

impl Hash for Rect

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Rect

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

impl Eq for Rect

impl StructuralPartialEq for Rect