Enum gridly::grid::BoundsError

pub enum BoundsError {
    Row(RowRangeError),
    Column(ColumnRangeError),
    Both {
        row: RowRangeError,
        column: ColumnRangeError,
    },
}

An out-of-bounds error for a Location on a grid

This error is returned by methods that perform bounds checking to indicate a failed bounds check. It includes the specific boundary or boundaries that were violated.

Variants

Row(RowRangeError)

The location’s Row was out of bounds.

Column(ColumnRangeError)

The location’s Column was out of bounds.

Both

Fields

row: RowRangeError

column: ColumnRangeError

Both the Row and the Column were out of bounds.

Implementations

impl BoundsError

pub fn row(&self) -> Option<&RowRangeError>

The row component of the boundary error, if applicable.

use gridly::prelude::*;

let row_error = RowRangeError::TooLow(Row(0));
let col_error = ColumnRangeError::TooLow(Column(0));

assert_eq!(BoundsError::Row(row_error).row(), Some(&row_error));
assert_eq!(BoundsError::Column(col_error).row(), None);
assert_eq!(
    BoundsError::Both{row: row_error, column: col_error}.row(), Some(&row_error)
);

pub fn column(&self) -> Option<&ColumnRangeError>

The column component of the boundary error, if applicable.

use gridly::prelude::*;

let row_error = RowRangeError::TooLow(Row(0));
let col_error = ColumnRangeError::TooLow(Column(0));

assert_eq!(BoundsError::Row(row_error).column(), None);
assert_eq!(BoundsError::Column(col_error).column(), Some(&col_error));
assert_eq!(
    BoundsError::Both{row: row_error, column: col_error}.column(), Some(&col_error)
);

Trait Implementations

impl Clone for BoundsError

fn clone(&self) -> BoundsError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BoundsError

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

Formats the value using the given formatter.

impl Display for BoundsError

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

Formats the value using the given formatter.

impl From<RangeError<Column>> for BoundsError

fn from(err: ColumnRangeError) -> Self

Converts to this type from the input type.

impl From<RangeError<Row>> for BoundsError

fn from(err: RowRangeError) -> Self

Converts to this type from the input type.

impl PartialEq for BoundsError

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

impl Eq for BoundsError

impl StructuralEq for BoundsError

impl StructuralPartialEq for BoundsError