Enum geo::algorithm::dimensions::Dimensions

pub enum Dimensions {
    Empty,
    ZeroDimensional,
    OneDimensional,
    TwoDimensional,
}

Geometries can have 0, 1, or two dimensions. Or, in the case of an empty geometry, a special Empty dimensionality.

Examples

use geo_types::{Point, Rect, line_string};
use geo::algorithm::dimensions::{HasDimensions, Dimensions};

let point = Point::new(0.0, 5.0);
let line_string = line_string![(x: 0.0, y: 0.0), (x: 5.0, y: 5.0), (x: 0.0, y: 5.0)];
let rect = Rect::new((0.0, 0.0), (10.0, 10.0));
assert_eq!(Dimensions::ZeroDimensional, point.dimensions());
assert_eq!(Dimensions::OneDimensional, line_string.dimensions());
assert_eq!(Dimensions::TwoDimensional, rect.dimensions());

assert!(point.dimensions() < line_string.dimensions());
assert!(rect.dimensions() > line_string.dimensions());

Variants

Empty

Some geometries, like a MultiPoint or GeometryColletion may have no elements - thus no dimensions. Note that this is distinct from being ZeroDimensional, like a Point.

ZeroDimensional

Dimension of a point

OneDimensional

Dimension of a line or curve

TwoDimensional

Dimension of a surface

Trait Implementations

impl Clone for Dimensions

pub fn clone(&self) -> Dimensions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Dimensions

impl Debug for Dimensions

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

Formats the value using the given formatter.

impl Eq for Dimensions

impl Ord for Dimensions

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Dimensions> for Dimensions

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Dimensions> for Dimensions

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

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub 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 StructuralEq for Dimensions

impl StructuralPartialEq for Dimensions